Skip to content

ESMPy Release Procedure

Bill Sacks edited this page Feb 12, 2025 · 3 revisions

Before Freeze

  • Run tests:

    • python setup.py test
    • python setup.py test_parallel
    • python setup.py test_examples
    • python setup.py test_examples_parallel
  • Run "slow" and "data" tests:

    • nosetests -vs -a "slow, data"
  • Run regrid_from_file tests:

    • python setup.py test_regrid_from_file
    • python setup.py test_regrid_from_file_parallel
  • Run notebooks

    • Start jupyter and run all notebooks
  • Update the ESMPy README and __init__.py

  • Update links in README, and ESMPy/doc directory

  • Update the Installation section of the ESMPy docs

  • Compile supported platforms and add to the table on the release page

  • Check that version in src/addon/esmpy/pyproject.toml is correct; note the importance of removing "beta" from this version, so it should look like "8.7.0"

  • Compile release notes

    • Run diff between current version and last to verify
  • Compile known bugs

    • Check that known bug pydoc strings are current

After Final Tag:

  • Create html and latexpdf docs for ESMF website

  • Create conda package for new tag and add to NESII Anaconda Packages page

    • Update tag in esmf-feedstock and esmpy-feedstock and push to conda-forge
      • Use the conda-forge package maintainer's manual

After release:

  • Bump version in setup.py