NCAR/miles-credit: v2026.1.1

Summary

• New users can now train and run a model based entirely on the config/example-v2026.1.0.yml config file on Casper or Derecho without having to make modifications. For users on other systems, data paths will need to change but other components will still work.
• This is the last release focused on the CREDIT Generation 1 API. v2026.2.0 will begin implementing the Generation 2 API, which will use a more modular set of multi-source Datasets, pre-blocks, and post-blocks to handle data transformations and diagnostic calculations. The Generation 1 API and associated dataset classes and models will still be maintained in the new update but future feature development will focus on the Gen 2 API. Conversion scripts for config files to go from Gen 1 to Gen 2 will also be provided.
• New Gen 2 Datasets and Preblocks are included in this release but are not fully connected with the model pipeline yet. We will have a full Gen 2 model pipeline in the next release.
• We highly recommend building a new conda environment before running this CREDIT release. The number of dependencies has been reduced, and the code has been tested against numpy 2.4 and the most recent versions of pytorch. See the Getting Started instructions in the docs on how to create a new environment and link to a CUDA-enabled version of PyTorch that can run on Casper or other NVIDIA GPU machines. If you want to use the p-type functionality or any of the optional dependencies, run pip install -e ".[ptype]" or pip install miles-credit[ptype]. We also have a [develop] set of optional dependencies if you are making code contributions.
• The Derecho environment creation script has also been updated to support the newer versions of pytorch compiled with the system MKL and MPI.
• We have completed a bunch of updates under the hood to improve testing and code contributing with many more planned in the next few releases.

What's Changed

• Streamlines Ruff configuration, adds pre-commit.ci, and applies linting/formatting fixes by @kafitzgerald in https://github.com/NCAR/miles-credit/pull/269
• Fix MPI conda channel issue in create_derecho_env.sh by @djgagne in https://github.com/NCAR/miles-credit/pull/279
• two fixes -- mpi + torch version for derecho by @negin513 in https://github.com/NCAR/miles-credit/pull/281
• Update era5.py by @charlie-becker in https://github.com/NCAR/miles-credit/pull/280
• Update getting-started.md by @sgpearse in https://github.com/NCAR/miles-credit/pull/282
• Bump the actions group with 2 updates by @dependabot[bot] in https://github.com/NCAR/miles-credit/pull/284
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in https://github.com/NCAR/miles-credit/pull/285
• Preblocks by @charlie-becker in https://github.com/NCAR/miles-credit/pull/283
• Dataset refactor by @charlie-becker in https://github.com/NCAR/miles-credit/pull/291
• Bump codecov/codecov-action from 5.5.2 to 5.5.3 in the actions group by @dependabot[bot] in https://github.com/NCAR/miles-credit/pull/293
• Fix to example config by @djgagne in https://github.com/NCAR/miles-credit/pull/294
• CI check to run inference on each Pull Request by @sgpearse in https://github.com/NCAR/miles-credit/pull/286
• adding a new energy post-block that doesn't use net notation by @WillyChap in https://github.com/NCAR/miles-credit/pull/301
• Bump the actions group with 2 updates by @dependabot[bot] in https://github.com/NCAR/miles-credit/pull/311
• Coupled camulator by @WillyChap in https://github.com/NCAR/miles-credit/pull/287
• CI / Actions updates and bump minimum Python version to 3.11 by @kafitzgerald in https://github.com/NCAR/miles-credit/pull/313
• Updated example config and docs by @djgagne in https://github.com/NCAR/miles-credit/pull/300
• Bump actions/download-artifact from 8.0.0 to 8.0.1 in the actions group across 1 directory by @dependabot[bot] in https://github.com/NCAR/miles-credit/pull/321
• Domain parallelism for V2: spatial sharding across GPUs for high-resolution training by @negin513 in https://github.com/NCAR/miles-credit/pull/320
• Add a PR template by @kafitzgerald in https://github.com/NCAR/miles-credit/pull/325
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in https://github.com/NCAR/miles-credit/pull/326
• Preblocks by @charlie-becker in https://github.com/NCAR/miles-credit/pull/297
• Configuration File Docs Text Update by @danineamati in https://github.com/NCAR/miles-credit/pull/327
• Bump the actions group across 1 directory with 2 updates by @dependabot[bot] in https://github.com/NCAR/miles-credit/pull/336
• gfs_init and rollout_realtime now work with the example config by @djgagne in https://github.com/NCAR/miles-credit/pull/334
• Deleting old notebooks and large files in repo. by @djgagne in https://github.com/NCAR/miles-credit/pull/338

New Contributors

• @pre-commit-ci[bot] made their first contribution in https://github.com/NCAR/miles-credit/pull/285

Full Changelog: https://github.com/NCAR/miles-credit/compare/v2026.1.0...v2026.1.1