XanaduAI / strawberryfields

Strawberry Fields is a full-stack Python library for designing, simulating, and optimizing continuous variable (CV) quantum optical circuits.
https://strawberryfields.ai
Apache License 2.0
747 stars 186 forks source link

Development requirements and formatting #563

Closed Aaron-Robertson closed 3 years ago

Aaron-Robertson commented 3 years ago

Context:

Discussed on #561

Description of the Change:

Adds a development environment section to development docs, and an associated dev_requirements.txt for installation. Includes a black format script run by make format with associated instructions in development docs and PR template.

Benefits:

Makes contribution easier.

Possible Drawbacks:

N/A

Related GitHub Issues:

N/A

codecov[bot] commented 3 years ago

Codecov Report

Merging #563 (294963c) into master (7a66d31) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #563   +/-   ##
=======================================
  Coverage   98.36%   98.36%           
=======================================
  Files          76       76           
  Lines        8325     8325           
=======================================
  Hits         8189     8189           
  Misses        136      136           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 7a66d31...294963c. Read the comment docs.

co9olguy commented 3 years ago

Thanks @Aaron-Robertson :smiley: