Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.92 KB

DEVELOPING.rst

File metadata and controls

76 lines (47 loc) · 2.92 KB
Raw

Development notes

The repository and package aim to be ruthlessly simple, and thus as easy as possible to maintain. Thus:

  • No built documentation; like pycountry, the README is the documentation.
  • Actual code (in __init__.py) kept to a minimum.
  • Versioning:
    • similar to pycountry: <YYYY>.<M>.<D>.
    • setuptools-scm and git tags used for all versioning; nothing hardcoded.
  • Minimal CI configuration: one service/OS/Python version.
  • AUTHORS: anyone adding a commit to the repo should also add their name to AUTHORS.

Releasing

Before releasing, check https://github.com/IAMconsortium/units/actions/workflows/test.yaml to ensure that the push and scheduled builds are passing. Address any failures before releasing.

  1. Create a new branch:

    $ git checkout -b release/YYYY.MM.DD

  2. Tag the release candidate (RC) version, i.e. with a rcN suffix, and push:

    $ git tag v2021.3.22rc1
$ git push --tags origin release/YYYY.MM.DD

  3. Open a PR with the title “Release vYYYY.MM.DD” using this branch. Check:

    Address any warnings or errors that appear. If needed, make a new commit and go back to step (2), incrementing the rc number.

  4. Merge the PR using the ‘rebase and merge’ method.

  5. (optional) Switch back to the main branch, tag the release itself (without an RC number) and push:

    $ git checkout main
$ git pull --fast-forward
$ git tag v2021.3.22
$ git push --tags origin main

    This step (but not step (2)) can also be performed directly on GitHub; see (6), next.

  6. Visit https://github.com/IAMconsortium/units/releases and mark the new release: either using the pushed tag from (5), or by creating the tag and release simultaneously.
  7. Check at https://github.com/IAMconsortium/units/actions/workflows/publish.yaml and https://pypi.org/project/iam-units/ that the distributions are published.

Generated data files for GWP contexts

iam_units/data/emissions/emissions.txt defines the base units for Pint, and imports the other files iam_units/data/emissions/*.txt. These files each define one context, and contain a notice that they should not be edited manually.

First, install the globalwarmingpotentials package:

$ pip install globalwarmingpotentials

Update these files using the command:

$ python -m iam_units.update emissions

The update submodule writes the context files. When adding a new context file, make sure to @import it in emissions.txt and expand the tests.