This is reference material for local development.

If you just want to use the library, you don’t need any of this.

Release checklist

  • Verify tests and examples work

  • Check that all documentation is updated

  • Update version number (``version) in gridsim/`

  • Update changelog: move “Unreleased” to new version

  • Push to master

  • Create release on Github (This will automatically create a new documentation version on Read The Docs and deploy an updated release to PyPi)

Build Documentation

from the docs directory, run:

make html

Then open the documentation:

open _build/html/index.html

Build the distributable for PyPi

(From the PyPi tutorial)

You shouldn’t need to do this manually anymore; this will be handled by Travis CI

Make sure the necessary dependencies are installed.

pip3 install --upgrade setuptools wheel twine

Build the project. From the project root folder, run:

python3 sdist bdist_wheel

Upload it to the testing index:

python3 -m twine upload --repository-url dist/*

Upload it to the actual index:

python3 -m twine upload dist/*