Reporting Bugs, Contributing and Releasing¶
We welcome contributions, whether as bug reports, improvements to the code, or more examples.
Please note that all contributions are subject to our code of conduct.
odes bug tracker is on GitHub.
When reporting bugs, please include the versions of Python,
odes and SUNDIALS,
as well as which OS this appears on.
Getting the code¶
The primary repository is at https://github.com/bmcage/odes, and it is the repository that pull requests should be made against.
Work should be done in a private branch based on master, with pull requests made against master.
Running the Tests¶
odes uses tox to manage testing across
To install tox, use:
pip install tox
and to run the tests, inside the top level of the repository, run:
Examples should be added in the
Adding ipython/jupyter notebook examples¶
Please submit extra jupyter notebook examples of usage of
notebooks should go in
ipython_examples, and add a short description to
Creating a New Release¶
- Set in
common.pyversion string and
DEV=False, commit this.
- On GitHub, draft a new release by clicking the appropriate button. Give correct version number, and hit release. This will upload the release for a DOI to Zenodo as draft.
- Go to uploads in Zenodo, edit the uploaded new release, save and hit the publish button. This will generate a DOI.
- Update to PyPI:
python setup.py sdist --formats=gztar register upload
- Update version string to a higher number in
DEV=True, next copy the DOI badge of Zenodo in the
README.md, commit these two files.
For the documentation, you need following packages:
sudo apt-get install python-sphinx python-numpydoc python-mock
After local install, create the new documentation via
- Go to the sphinx directory:
- Create the documentation:
- Upload the new html doc.