IMAS-Python development and release process¶

IMAS-Python development follows the a fork-based model described in the contributing guidelines.

Creating an IMAS-Python release¶

1. Create a Pull Request from develop to main.

2. Add a change log to the Pull Request, briefly describing new features, bug fixes, and update accordingly the Changelog.

3. The PR is reviewed and merged by the maintainers who also create the release tags.

4. After the release PR is merged, update the Easybuild configurations for SDCC modules in the easybuild-easyconfigs repository. See the next section for more details on how to do this.

Updating and testing the IMAS-Python Easybuild configuration¶

The following steps must be performed for each of the supported tool chains (currently intel-2023b, foss-2023b):

1. Create the .eb file for the new release.

   1. Copy the .eb file from the previous release.

   2. Update the version to reflect the just-released version tag.

   3. If any of the IMAS-Python dependencies in pyproject.toml where updated or changed since the previous release, update the easybuild dependencies:

      • builddependencies contains build-time dependencies which are available as a module on SDCC.

      • dependencies contains run-time dependencies which are available as a module on SDCC.

      • exts_list contains python package dependencies (and potentially dependencies of dependencies) which are not available in any of the Python modules on SDCC.

   4. Update the checksum of imas: download an archive of the IMAS-Python repository from bitbucket. This is easiest to do by copying the following URL, replace <version> with the version tag, and paste it in a web browser:

      https://github.com/iterorganization/IMAS-Python/archive/refs/tags/<version>.tar.gz
      

      Then, calculate the hash of the downloaded archive with sha256sum and update it in the .eb file.

2. Test the easybuild configuration:

   1. Create an easybuild module, replace <eb_file> with the filename of the .eb file created in step 1.

      module purge
      module load EasyBuild
      eb --rebuild <eb_file>
      

      If this is unsuccessful, investigate the error and update the .eb configuration. A useful environment variable for debugging is export PIP_LOG=pip.log, which instructs pip to write logs to the specified file (pip.log in this example).

   2. If the module was successfully installed by easybuild, load it:

      module purge
      module use ~/.local/easybuild/modules/all/
      module load IMAS-Python/<version>-<toolchain>
      module laod IMAS-AL-Core
      

   3. Sanity check the module, for example by running the pytest unit tests.