Changelog

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

The changes listed in this file are categorised as follows:

• Added: new features

• Changed: changes in existing functionality

• Deprecated: soon-to-be removed features

• Removed: now removed features

• Fixed: any bug fixes

• Security: in case of vulnerabilities.

master

v2.0.1 - 2025-11-28

Changed

• (!36) Update the .readthedocs.yml file to V2 and fix the docs pipeline.

v2.0.0 - 2025-10-15

This version enhances the tooling to support data validation and submission for the new RCMIP Phase 3.

Changed

• (!35) Modify the upload function (which supports the rcmip upload command) to create scenario-specific netCDF files from the submission bundle supplied by the user, which are subsequently uploaded to the remote server.

• (!35) Modify the upload function to allow for different endpoints beyond AWS, pointing it by default at NIRD (which is where RCMIP3 data will be stored).

• (!35) Modify the submitting_results.rst file with the intended workflow for RCMIP3 users employing this tool.

• (!35) Update notebooks to work with the new version of the tooling.

• (!35) Update black to version 22.3.0.

• (!35) Update versioneer to 0.29.

• (!35) Update moto to a minimum version of 4.2.0.

• (!35) Limit notebook dependency to version 7 or lower in jupyter notebook requirements.

Added

• (!35) Add an optional --comments flag to enable the specification of a file to upload containing comments about the submission.

• (!35) Add functionality related to the above addition, supporting the reading and validation of comment files (excel sheet or CVS).

• (!35) Add option to the rcmip download command to unzip downloaded files.

• (!35) Add a new command, rcmip convert-to-csvs, which takes netCDF files as produced by this tooling and converts them to two CSV files, one with the simulation data and another with the model metadata.

• (!35) Enhanced the testing suite to cover the changes and additions functionality in this PR.

• (!35) Add netcdf4 to test requirements.

• (!35) Add widgetsnbextension to jupyter notebooks requirements.

Removed

• (!35) Remove or comment functionality related to the model metrics, which we are not going to be requesting in the new RCMIP phase.

v1.0.0 - 2025-11-07

Added

• (!32) pyrcmip.stats.sample_multivariate_skewed_normal() to allow sampling of a multi-variate skewed normal distribution

v0.5.2 - 2022-02-08

Changed

• (!31) Move docutils to the docs extra requirements as it is only needed for building the documentation

v0.5.1 - 2021-08-18

Added

• (!30) pyrcmip.metric_calculations.CalculatorAirborneFraction18501920 and pyrcmip.metric_calculations.CalculatorAirborneFraction18501990 for calculating airboren fraction

• (!28) Scripts for uploading the RCMIP protocol to Zenodo

Changed

• (!29) Compare the ETag value from S3 against the md5sum from zenodo for the protocol data. This requires the protocol data to be uploaded as a single part as for multipart uploads the Etag != md5sum of the uploaded file

v0.5.0 - 2021-02-23

Changed

• (!27) Use openpyxl rather than xlrd as excel engine

• (!27) Upgrade to pyjwt>=2

• (!27) Upgrade to scmdata>=0.7.3

Fixed

• (!26) Remove rogue cells in data submission template (new template released as v5-1-0)

v0.4.1 - 2020-09-14

Fixed

• (!25) Usage of old seaborn API in plotting and broken unit check

v0.4.0 - 2020-09-13

Added

• (!23) Documentation and tests for pyrcmip.assessed_ranges and pyrcmip.metric_calculations

• (!22) Add support for downloading submitted data

Changed

• (!23) pyrcmip.database.Database.load_data() now requires a climate_model argument

• (!23) pyrcmip.database.Database.save_summary_table() now expects an "RCMIP name" column, rather than "metric"

• (!23) Metric calculations now use the pyrcmip.metric_calculations.base.Calculator

• (!24) Pin test dependency moto==1.3.14

• (!21) Timeseries submissions must include an ensemble_member column

Removed

• (!23) pyrcmip.database.time_mean()

v0.3.0 - 2020-09-02

Added

• (!19) Clearer error message if the timeseries submission doesn’t contain climate_model or unit metadata

• (!17) Update create-token script to allow for rotating of tokens

Changed

• (!20) Each input timeseries is now individually validated and uploaded when using the cli

v0.2.1 - 2020-09-01

Added

• (!18) Clarification that pyrcmip only supports Python 3.6+

• (!18) Add support from submission from gzipped csv

• (!16) Add the ability to specify multiple timeseries files via the CLI. Closes (#3)

v0.2.0 - 2020-08-17

Added

• (!14) Check if the templates have changed during CI

• (!12) Add readthedocs configuration

• (!10) Documentation of submission process

• (!6) Skeleton of data processing, including illustrative model submission and processing pipeline

• (!5) Basic docs

Changed

• (!13) Fix broken documentation on readthedocs

• (!8) Upload data, metadata and model reported values together

• (!7) Require validation before uploading

• (!6) Submissions now require three parts: timeseries, model reported and metadata rather than only just one

• (!4) Require scmdata >= 0.6.1

v0.1.1 - 2020-07-09

Changed

• Fixed readme

v0.1.0 - 2020-07-09

Added

• CLI framework

• Basic checks