Snippets used while developing new features

[ngraymon]

You can always just generate files for testing from driver.py:
to generate the current Z2 residual equations:

python3 termfactory/driver.py -t 2 2 1 4 4 -c

and Z3

python3 termfactory/driver.py -t 2 3 1 4 4 -c

Alternatively the blanket.py tests are a quick easy way to generate the full files:

• cd into /termfactory/test/blanket/

then to generate all of them

• pytest blanket_test.py -sx -vv

or to run only a specific class of tests:

• pytest blanket_test.py -k 'Test_code_fcc' -sx -vv
  used while working on Implement opt_einsum generator for full cc #76

• pytest blanket_test.py -k 'Test_code_dt_equations' -sx -vv
  used while working on Fix opt_einsum paths for dt_equations #75

To manually check the coverage report use the deep tests:

• cd into /termfactory/tests/

Run all the deep tests

• python3 -m coverage run -m pytest -k 'deep' -sx -vv

or, better yet run only the tests you need

• python3 -m coverage run -m pytest deep/ -k 'Test_write_cc_optimized_paths_from_list' -sx -vv

Say we want to specifically look at the blanket coverage:

• python3 -m coverage run -m pytest blanket_test.py -sx -vv

Then once that's done we can generate the report

• python3 -m coverage report

We can also find what lines we need to correct with

• python3 -m coverage report -m

Or if I want to check coverage on just the code_full_cc.py while I'm making changes:

• python3 -m coverage report -m ./../../termfactory/code_full_cc.py:

Name                                  Stmts   Miss  Cover   Missing
-------------------------------------------------------------------
./../../termfactory/code_full_cc.py     457     10    98%   94-101, 217-218, 235-236, 260
-------------------------------------------------------------------
TOTAL                                   457     10    98%

See https://coverage.readthedocs.io/en/latest/cmd.html#cmd-report for more options

[ngraymon]

Need to use
python3 -m coverage run -m pytest ./tests/ -k 'deep' >> printing_output.txt
to specifically get the .coveragearc file (and the specific pragma's) to apply

[ngraymon]

Good reference
https://gist.github.com/kwmiebach/3fd49612ef7a52b5ce3a