Home

Welcome to the meegsim wiki! Currently, it only contains some notes about development.

Releasing a new version

This could be potentially be done with GitHub Actions, but here's a checklist for now:

1. Update the version number in pyproject.toml.
2. Move to contents of the Unreleased section in the CHANGELOG.md to the section of the new version.
3. Copy the changelog for the new version to docs/changelog/*version*.md and include it in the docs/development/whats_new.rst.
4. Update the contents of docs/_static/versions.json: make the new version stable and preferred.
5. Update the version number in CITATION.cff.
6. Upload the package to PyPI.
7. Make a release on GitHub.

After the release:

1. Set the new dev version in pyproject.toml.
2. Add the new dev version to docs/_static/versions.json.