Things to check if new functionality added:
Ensure functions are unit tested.
Ensure functions have numpy style docstrings.
Ensure code is PEP8 compliant.
If module, add to
"__all__"if appropriate (or the tensor network equivalent
Add to changelog and elsewhere in docs.
Running the Tests¶
quimb requires pytest (as well as
pytest-cov) and simply involves running
pytest in the root
The tests can also be run with pre-spawned mpi workers using the command
quimb-mpi-python -m pytest (but not in syncro mode – see Distributed Parallelism - MPI).
Building the docs locally¶
To start from scratch, remove
make.bat htmlon windows) in the
Launch the page:
Minting a Release¶
Make sure all tests are passing, as well as the continuous integration and readthedocs build.
git tagthe release with next
X.Y.Z(n.b. no ‘v’ prefix).
Remove any old builds:
Build the tar and wheel
python setup.py bdist_wheel sdist
Optionally remove the
Upload using twine:
twine upload dist/*