v0.3.0

Announcements

• We've switched the default citation granularity to model level, rather than experiment level
• We now support using paths as input

Changelog

⚠️ Breaking Changes

• 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)

🆕 Features

• • 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

  (#7)

📚 Improved Documentation

• Split how-to get citations docs into basic and advanced (#7)

🔧 Trivial/Internal Changes

• #10

Changes

• 9301818 bump: version 0.2.0.post1 -> 0.3.0
• 2467de5 Revert to normal CI setup
• 3e3dd6f Run tests on all python versions
• be91dc0 CHANGELOG
• 9641807 Apply encoding to another file
• b87d8ef Add encoding arg
• 2c47946 Turn windows tests on
• b1c12f7 try to fix docs
• 8710944 small adj to docs
• 02e75e7 try to fix guide
• dae5ab6 rename granularity + add doc
• e185586 Fix docs CI
• bf1911b Last cleaning up
• e7dcea4 Clean up README
• adf8b76 Update after review
• 0a8e5f5 Fix up bad copy paste
• ac4e4a0 Avoid tests exploding if optional extras are not installed
• 10afd33 Add more clarity re optional dependencies
• a584052 Update README to point to optional dependencies
• 9e3af0a Test names and CHANGELOG
• a8572e8 docstrings
• abb7503 Update pyproject.toml
• 5ff6e79 CHANGELOG and docs
• 0107318 lower netcdf ?
• 41b29fb fix deps
• 27097a4 fix example
• 9ff5faa cast str and missing doilev
• fe170b2 add netcfd4 dep
• 51ba676 extra line
• d033a9e improve docs
• 6984463 fix tests
• 0cba6a6 add tests and docs
• 9ffa106 add paths and add doi level
• ebc0f2b bump(pre-release): version 0.2.0 > 0.2.0.post1

v0.2.0

Announcements

• We have added support for getting citations for files that are members of multiple datasets i.e. associated with multiple PIDs 🎉
  • This required some alterations to the API, see below (and if you're such an early adopter that this matters to you, congrats)

Changelog

⚠️ Breaking Changes

• • 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.

  (#5)

🆕 Features

• 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)

  (#5)

🎉 Improvements

• • 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

  (#5)

Changes

• 032040e bump: version 0.1.3.post1 -> 0.2.0
• 5f877b2 Add docstring
• 8e1a76c Add doctest
• 5e1be39 Fix up typo in CHANGELOG
• 870569a Further clarifications
• 596954d Update CHANGELOG
• f9c7d8c Include version info in multiple PID error
• 8cf1ada Add CLI-like API layer
• f898926 Add suitable pragma: no cover
• 9e2f53f mypy
• ae04e4e CHANGELOG
• 6847175 Docs
• 66d7dae Finish off multi-use support
• e177426 Start on higher level functions
• 718393f Add handling strategy for tracking IDs in multiple datasets
• 44b346a add explainer
• 97a445d Apply suggestions from code review
• be1f1de changelog
• a52b1d9 short author
• 7a82cba try to pass coverage
• d437fa6 add test
• 9b7db86 fix cli
• 475af60 use agg_lev
• 55e2300 fix doc
• 34fdbf0 pid vs tracking
• fb1d691 bump(pre-release): version 0.1.3 > 0.1.3.post1

v0.1.3

Announcements

• Nothing to announce, just checking tokens work

Changelog

No significant changes.

Changes

• 034b4ee bump: version 0.1.2.post1 -> 0.1.3
• 6f43c66 bump(pre-release): version 0.1.2 > 0.1.2.post1

v0.1.2

Announcements

• Announcement 1

Changelog

No significant changes.

Changes

• 8148e38 bump: version 0.1.1.post1 -> 0.1.2
• 2b62a98 Add licence
• ca2401d bump(pre-release): version 0.1.1 > 0.1.1.post1

v0.1.1

Announcements

• Announcement 1

Changelog

🆕 Features

• Add basic cmipcite get command-line interface and associated Python API (#1)