Maintainer info¶

This is a collection of some notes for maintainers.

Python / numpy versions to support¶

ctapipe follows NEP 29.

This means ctapipe will require the following minimum python / numpy releases vs. time:

After 2020-06-23 drop support for Python 3.6 (initially released on Dec 23, 2016) After 2021-07-26 drop support for Numpy 1.17 (initially released on Jul 26, 2019) After 2021-12-22 drop support for Numpy 1.18 (initially released on Dec 22, 2019) After 2021-12-26 drop support for Python 3.7 (initially released on Jun 27, 2018) After 2022-06-21 drop support for Numpy 1.19 (initially released on Jun 20, 2020) After 2023-04-14 drop support for Python 3.8 (initially released on Oct 14, 2019)

However, for specific features, ctapipe could require more recent versions of numpy. E.g. for the astropy quantity interoperability, we required 1.17 earlier than 2021.

How to update the online docs?¶

The docs are automatically build by travis and uploaded to github pages.

To do it manually, follow these instructions:

First install ghp-import

pip install ghp-import

Then build the docs:

python setup.py build_docs --clean-docs

If there’s no warnings, you can publish the docs with this command

ghp-import -n -p -m 'Update gh-pages docs' docs/_build/html

which is equivalent to this make target so that you don’t have to remember it:

make doc-publish

Only ctapipe maintainers can do this, because you need write permission to the main repo.

How to make a release?¶

Open a new PR to generate a meaningfull changelog. Run towncrier in order to do this:

towncrier build --version=<VERSION NUMBER>

Create a new github release, a good starting point should already be made by the release drafter plugin.
The PyPI upload will be done automatically by travis
conda packages are built by conda-forge, the recipe is maintained here: https://github.com/conda-forge/ctapipe-feedstock/ An pull request to update the recipe should be opened automatically by a conda-forge bot when a new version is published to PyPi.