Releases

Creating Source Releases

Quantities is distributed as a source release for Linux and Mac OS. To create a source release, just do:

pip install build
python -m build
twine upload dist/quantities-<x.y.z>.*

(replacing x, y and z appropriately). This will create the tgz source file and upload it to the Python Package Index. Uploading to PyPi requires a .pypirc file in your home directory, something like:

[server-login]
username: <username>
password: <password>

You can create a source distribution without uploading by doing:

python -m build --sdist

This creates a source distribution in the dist/ directory.

Building Quantities documentation

The Quantities documentation is automatically built on readthedocs.io.

Should you need to build the documentation locally, Sphinx, LaTeX (preferably TeX-Live), and dvipng are required. Once these are installed, do:

cd doc
make html

which will produce the html output and save it in build/sphinx/html. Then run:

make latex
cd build/latex
make all-pdf
cp Quantities.pdf ../html

which will generate a pdf file in the latex directory.