Checklist for a new release

Follow this checklist when creating a new release, i.e. updating the version number.

  1. Check deprecated features, e.g. full-text search for .. deprecated ::, DeprecationWarning and FutureWarning. They should mention at which release the deprecated implementations will be removed. If they are due, remove them.

  2. Make sure that tenpy can be compiled (bash ./ and installed (pip install .). Make sure that all tests run successfully. A convenient way to check this is to re-run the actions on the latest commit.

  3. Update the changelog and release notes.

    • The “latest” contributions should have added entries in doc/changelog/latest/. Starting a docbuild (make html) pastes all of these entries into doc/changelog/_latest.rst, even if aborted after a few seconds.

    • Check the commit list on the main branch and make sure all important changes are listed in the changelog.

    • Create a new changelog file by duplicating the doc/changelog/template.txt. Name it vX.Y.Z.rst according to the new version number. Include all notes from the latest changelog, add a summary, adjust the title.

    • Add the new file to the toctree in doc/releases.rst.

    • Delete the outdated files in doc/changelog/latest.

    • Make sure to not delete the doc/changelog/latest/README though!

    • Make sure to not accidentally commit changes to doc/changelog/_latest.rst. It should be empty except for the header.

  4. Update tenpy/

    • Update the release number.

    • set released=True.

  5. Create the version commit and a tag:

    git commit -m "VERSION 0.42.1"
    git tag -s "v0.42.1"

    Change the version number appropriately! We usually choose VERSION 0.42.1 for the commit message of the tag as well. You should GPG sign the commit.

  6. Reset the released=False flag in tenpy/ Commit and push these changes:

    git add tenpy/
    git commit -m "reset released=False"
    git push
    git push origin v0.42.1  # also push the tag
  7. Pushing a tag should cause a github action to publish to It executes .github/workflows/publish.yml. Double check that everything looks ok there.

  8. Perform a test installation.

    This is best done in a dedicated fresh environment. Since the dependencies (numpy, scipy) are not available on TestPyPI, we need to pre-install them. On live PyPI we could omit them here and pip install physics-tenpy would install them for us:

    conda create -n tenpytest python=3.12 pip numpy scipy h5py pyyaml pytest ipython
    conda activate tenpytest
    pip install -i physics-tenpy==0.42.1

    Make sure your working directory is not the root folder of a tenpy repo. That would cause the tenpy version from the repo to be in the path and probably take precedence over the tenpy version that we just installed. In e.g. an ipython console, check that tenpy can be imported without errors and warnings and check that you are importing the correct version:

    In [1] import tenpy as tp
    In [2]: print(tp.__file__)  # make sure the following path contains 'site-packages'.
    In [3]: tp.show_config()  # check the version number
    tenpy 0.11.0.dev0+unknown (compiled without HAVE_MKL),
    git revision unknown using
    python 3.12.1 | packaged by Anaconda, Inc. | (main, Jan 19 2024, 09:45:58) [Clang 14.0.6 ]
    numpy 1.26.3, scipy 1.11.4

    Run the test suite. Again, ensure that you are not in the root directory of the repo:

    pytest path/to/local/repo/tests
  9. Create a release with release notes on github. The release triggers the github action for uploading the package to PyPI. It executes .github/workflows/publish.yml.

  10. Wait for conda-forge bot to create a pull request in the feedstock repo and merge it.

If something goes wrong

The following is a loose collection of tips and pointers, in case something goes wrong during the release steps outlined above.

  • If you notice the problem quickly, cancel the TestPyPI publishing action. TestPyPI, like the live PyPI can not be modified once uploaded and accepts only one upload per unique version number. If you do not do this quick enough, subsequent uploads to TestPyPI (with the same version number) will fail.

  • After fixing the problems, you can simply make a second "VERSION 0.42.1" commit. Consider putting an explanation into the commit message; what went wrong the first time?

  • To “move” the tag to the new commit follow these steps:

    git tag -d <tagname>                  # delete the old tag locally
    git push origin :refs/tags/<tagname>  # delete the old tag remotely
    git tag <tagname> <commitId>          # make a new tag locally
    git push origin <tagname>             # push the new local tag to the remote
  • If there was already an upload to TestPyPI, the upload action triggered by pushing the tag will fail. Make sure the steps before uploading (building the wheels and checking them locally) run through without error. If you are reasonably sure that everything is ok still, you can ignore this failed action. If you want to check again, create a dummy branch, change the version number to something we will not use for actual releases, e.g. and manually publish.

How to publish on PyPI

Usually, PyPI publish should happen via github actions. This is how you would do it manually

Assume you working directory is the project root, i.e. the folder which contains Make sure you are running this in a recent python:

python -m pip install --upgrade pip
python -m pip install --upgrade setuptools wheel build twine

Then we build the package:

python -m build .

This will write the build to dist/. We can check that the project page on PyPI will render correctly with:

python -m twine check --strict dist/*

Then we can upload to via:

python -m twine upload -r testpypi dist/*

The twine command will prompt for credentials. Double check the project page on test.pypi. Finally, we upload to the live PyPI:

python -m twine upload dist/*