Releasing new versions

This page describes some of the steps required for releasing new versions of GCPy on Github, PyPi, and conda-forge.

1. Update CHANGELOG.md as necessary.
   
   

2. For clarity, update version numbers to the new release (X.Y.Z) in the following locations:

   • CHANGELOG.md

   • setup.py

   • gcpy/_version.py

   • docs/source/conf.py

   • gcpy/benchmark/run_benchmark.py

   • gcpy/benchmark/modules/run_1yr_fullchem_benchmark.py

   • gcpy/benchmark/modules/run_1yr_tt_benchmark.py

   This can be done by running the utility script:

   $ cd /path/to/GCPy/.release
   $ ./changeVersionNumbers.sh X.Y.Z
   

3. Merge dev into main
   
   

4. Publish the release on Github.
   
   

5. A GitHub Action will push the geoschem-gcpy package to the Python Package Index (PyPi).