Input4mips-validation

Announcements

* We have updated the package to be more in line with [the DRS description](https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk). This is a breaking change. For full details, please see below.

Changelog



⚠️ Breaking Changes

- Updated to better be in line with [the DRS description](https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk).
The DRS makes no comment on the values in the directory names,
hence we now make no assumptions and put no requirements on characters used in directory names.
The restriction to only a-z, A-Z, 0-9 and the hyphen plus special use of the underscore
is now only applied to file names.
As a result, files with variables that have underscores in their names
are now written with underscores in their directories, but not in their file name.
For example,
`.../mon/mole-fraction-of-methane-in-air/gn/.../mole-fraction-of-methane-in-air_input4MIPs_GHGConcentrations_CMIP_CR-CMIP-0-2-0_gn_200001-201012.nc`
is now written as
`.../mon/mole_fraction_of_methane_in_air/gn/.../mole-fraction-of-methane-in-air_input4MIPs_GHGConcentrations_CMIP_CR-CMIP-0-2-0_gn_200001-201012.nc`. ([83](https://github.com/climate-resource/input4mips_validation/pull/83))

🐛 Bug Fixes

- Fixed a bug in
[`validate_file_written_according_to_drs`][input4mips_validation.cvs.drs.DataReferenceSyntax.validate_file_written_according_to_drs]
which caused it to break if the file contained metadata which was not a string. ([83](https://github.com/climate-resource/input4mips_validation/pull/83))

🔧 Trivial/Internal Changes

- [81](https://github.com/climate-resource/input4mips_validation/pull/81), [#83](https://github.com/climate-resource/input4mips_validation/pull/83)



Changes

* 19a32ad bump: version 0.14.1a1 -> 0.15.0
* 1c2db42 CHANGELOG pt 3
* b35b062 Test handling of files that have non-string attributes
* 659bee1 Clarify note in drs
* 9cc9df6 CHANGELOG pt 2
* 081d8f1 CHANGELOG pt 1
* ae764d3 Update iris stubs
* c864890 Final comment
* 5ffe306 Workaround for non-string values in global metadata
* 7fb4b13 Fix up tests
* 18da4b8 Pass unit tests
* 3b5e735 Add test of hyphen underscore variable handling
* 6891412 Pass tests
* 4a127fd Add failing test
* cb51f96 Fix up typos in CHANGELOG
* 74ef598 CHANGELOG
* 0d330eb Bump mkdocs jupyter version

Announcements

* We have improved the API, particularly for writing data to disk. This gives you much more control over writing and the ability to make changes at multiple steps along the way (which can be necessary, given the complexity of the netCDF conversion). However, this also introduced quite a number of breaking changes. For details, see below.

Changelog



⚠️ Breaking Changes

- - The function signatures for [`input4mips_validation.dataset.Input4MIPsDataset.from_data_producer_minimum_information`][]
and [`input4mips_validation.dataset.Input4MIPsDataset.from_data_producer_minimum_information_multiple_variable`][]
have now been simplified to use an injectable [`prepare_func`][`input4mips_validation.dataset.dataset.PrepareFuncLike`][],
the default value of which is [`input4mips_validation.dataset.dataset.prepare_ds_and_get_frequency`][].
This makes the API simpler and gives the user more control.
However, it is a breaking change.
- We removed fine-grained control of writing to disk when using [`Dataset.write`][input4mips_validation.dataset.Input4MIPsDataset.write]
and [`input4mips_validation.io.write_ds_to_disk`][].
Instead, use [`Dataset.get_out_path_and_disk_ready_dataset`][input4mips_validation.dataset.Input4MIPsDataset.get_out_path_and_disk_ready_dataset]
or [`input4mips_validation.io.prepare_out_path_and_cubes`][] then write using you own writing function
(typically [`iris.save`][] instead).
- Renamed `bounds_dim` to `bounds_indicator` in [`input4mips_validation.dataset.dataset.handle_ds_standard_long_names`][].

([80](https://github.com/climate-resource/input4mips_validation/pull/80))

🆕 Features

- - Added [`Dataset.get_out_path_and_disk_ready_dataset`][input4mips_validation.dataset.Input4MIPsDataset.get_out_path_and_disk_ready_dataset]
and [`input4mips_validation.io.prepare_out_path_and_cubes`][]
to permit finer-grained control of file preparation and writing.
- Added [`input4mips_validation.dataset.dataset.add_bounds`][].

([80](https://github.com/climate-resource/input4mips_validation/pull/80))

🐛 Bug Fixes

- Fixed up passing of input arguments to underlying functions in `input4mips-validation validate-tree` ([75](https://github.com/climate-resource/input4mips_validation/pull/75))
- [`input4mips_validation.cvs.load_cvs`][] now supports variables of type `Path` for the `cv_source` argument.
As part of this fix, [`input4mips_validation.cvs.loading_raw.get_raw_cvs_loader`][] now also supports variables of type `Path` for the `cv_source` argument. ([80](https://github.com/climate-resource/input4mips_validation/pull/80))

🔧 Trivial/Internal Changes

- [79](https://github.com/climate-resource/input4mips_validation/pull/79)



Changes

* e3a445e bump: version 0.13.3a1 -> 0.14.0
* f68736e Remove script
* 9f3462c Fix up some more tests
* 95c9841 Fix changelog entries
* 946a910 Fix changelog entries
* e8980de Fix docs
* 953a673 Update CHANGELOG
* 198e2a9 Add changelog placeholders
* 6ee990e Add test of path handling for cv_source
* a516c1f Fix up general handling
* 0b5e0f0 CHANGELOG
* 59cfbd9 First fix ups
* 48df3cd Allow loading CVs from a Path
* d7c9d14 Fix up pinning for conda
* db6fb0d CHANGELOG
* 2522862 Fix up argument passing

Announcements

- Improved the error message if regexp parsing of paths fails for a given DRS. ([74](https://github.com/climate-resource/input4mips_validation/pull/74))

Changelog



🎉 Improvements

- Improved the error message if regexp parsing of paths fails for a given DRS. ([74](https://github.com/climate-resource/input4mips_validation/pull/74))

🔧 Trivial/Internal Changes

- [72](https://github.com/climate-resource/input4mips_validation/pull/72)



Changes

* 4eba036 bump: version 0.13.2a1 -> 0.13.2
* 8164eaf CHANGELOG
* 567c169 Add test
* a9cf801 Improve error message
* 4386718 Fix up docs workflow
* 31ee2af Fix up docs
* 46dd243 Update docs navigation
* e66baeb Fix up pre-commit config
* 88ccc23 Fix up workflow again
* 5f51885 Fix up workflow
* b9d1bbe CHANGELOG
* 314a73b Update repo structure