Changelog#

Versions follow Semantic Versioning (<major>.<minor>.<patch>).

Backward incompatible (breaking) changes will only be introduced in major versions with advance notice in the Deprecations section of releases.

CMIP Cite v0.3.0 (2025-11-13)#

Changed default citations to be 'model' granularity citations rather than 'model-experiment' granularity citations. In practice, this means that you will get fewer citations and they will be the ones that apply to all submissions for a given model, rather than one citation for each model-experiment combination that is found. (#7)

- Added support for taking paths to CMIP netCDF files as input
Added doi_granularity option so users can specify whether they want citations at the model or experiment granularity

- Changed the input arguments expected by cmipcite.citations.get_citations. The old format and author_list_style should now be handled when creating the value to pass to the new get_citation argument. This provides finer-grained control over how citations are generated (once the DOIs and versions have been determined). For an API that closely mirrors the command-line cmipcite get API, see cmipcite.citations.get.
Split cmipcite.citations.get_citation_for_id into cmipcite.citations.get_text_citation, cmipcite.citations.get_bibtex_citation and cmipcite.citations.get_doi_and_version. This allows the process of retrieving relevant DOIs and versions to be separated from how the citations for those DOIs and versions are retrieved and formatted.

get_citations now works with tracking_id and PID. (#3)
- Added cmipcite.citations.get to provide a Python API which closely mirrors the command-line cmipcite get command (cmipcite.citations.get_citations is a lower-level function which provides more flexibility to Python users looking for greater control)
Added the cmipcite.tracking_id module to support handling of tracking IDs specifically (as opposed to PIDs)

- Added support for getting citations for files that are members of multiple datasets i.e. associated with multiple PIDs
Added the --multi-dataset-handling and --handle-server-url arguments to the cmipcite get CLI to add the support above and avoid hard-coding the server URL used throughout

No significant changes.

No significant changes.