Ncas-amof-netcdf-template

Release notes
Fixed a bug where the platform global attribute wasn't being set with the correct value for instruments in the vocab list with a fixed location.

What's Changed
* Wrong platform value in global attribute by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/168


**Full Changelog**: https://github.com/joshua-hampton/ncas_amof_netcdf_template/compare/2.5.0...2.5.1

Release notes
This release includes needed updates for working with the 2.1.0 version of the NCAS General standard, in which the instrument information has been abstracted into its own repository. This means that previous versions of this package won't work properly with NCAS General 2.1.0, and those versions will error unless the `tag` option is specified as `2.0.0`.

The way in which this data, and the data for the standard, is retrieved and stored has been changed from a dictionary produced by `tsv2dict.instrument_dict` to a class object `file_info.FileInfo`. Using the class allows clearer labelling over the data and the structure of the data within each property, whereas previously the dictionary had multiple layers of nesting with differing complexity. This could cause confusion as to where data should be, and would lead to potentially misleading messages from IDE plugins.

With this version, support for Python 3.8 has been removed as this is now end of life, and support for Python 3.13 has been added.

Additional functionality includes:
* user defining QC flag values and meanings
* options to chunk, compress and shuffle variable data
* type hints added

What's Changed
* Use rst2pdf module for PDF documentation by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/129
* Define QC flag values and meanings by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/140
* Change conversion of flag values to list in error message by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/142
* New instrument vocabs by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/146
* Chunk and compress options by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/147
* Allow dimensionless variables by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/148
* Add type hints by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/150
* Replace very nested instrument dictionary with FileInfo class by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/155
* Added missing tag variable by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/156
* Deprecations by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/157
* Added option for local file use instead of AMF_CVs by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/159


**Full Changelog**: https://github.com/joshua-hampton/ncas_amof_netcdf_template/compare/2.4.0...2.5.0

Release notes

Preliminary release of version 2.5.0, including new location of instrument data, option to define QC flag values and meanings, and type hints added to code.
Still some changes before full v2.5.0 release, but needed for a version that works with latest NCAS General standard.

Release notes
This release adds a couple of new options to the module:
1. The ability to overwrite the default platform in both the file name and the global attribute - this is particularly useful for mobile instruments where the default is "mobile" and always needs changing before submitting the data files to CEDA. This can be accessed using the `platform` option in the `create_netcdf.main` and `create_netcdf.make_product_netcdf` functions.
2. Metadata files can now be provided in YAML, JSON or XML formats, as well as CSV. The expected layout for these formats is described in a new page in the documentation.

Additionally, the `return_open` option in some functions has had its default option changed to `True`, in line with the deprecation policy, and the `instrument_loc` option in `tsv2dict.product_dict` and `create_netcdf.make_product_netcdf` is being deprecated in favour of `platform`.

What's Changed
* New metadata file formats by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/124
* Overwrite platform by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/125
* Updates and deprecates by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/126


**Full Changelog**: https://github.com/joshua-hampton/ncas_amof_netcdf_template/compare/2.3.2...2.4.0

Release notes
Small bug fixes and more unit tests.
* Correct handling of microseconds in `util.get_times`
* Neatly add string numbers from metadata csv file

What's Changed
* More tests by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/119
* Correct handling of microseconds by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/119/commits/79d7e6a1b75c0e1da82f3f78f2c0f7970f75a0d0
* String numbers in metadata by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/120


**Full Changelog**: https://github.com/joshua-hampton/ncas_amof_netcdf_template/compare/2.3.1...2.3.2

Release notes
Small bug fix with very minor changes.
- Added package version number to text in the history global attribute.
- ``util.get_times`` returns ``day_of_year`` as a list rather than an array, in line with other times returned.

What's Changed
* Return day-of-year variable as list by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/111
* Add version number to history global attribute by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/112
* Use raw string for regular expression by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/114


**Full Changelog**: https://github.com/joshua-hampton/ncas_amof_netcdf_template/compare/2.3.0...2.3.1