Ncas-amof-netcdf-template

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

Release notes
This release adds the option to keep netCDF files open after creation. Previously, when calling `create_netcdf.main`, the netCDF file would be closed after it was made, meaning it then had to be opened again in append mode before data could be added. Now, the option has been added to keep the netCDF file open and return the open file from the function, saving the need to re-open the file. The previous method is still the default and is being deprecated, with the new method available using `return_open=True` in the `create_netcdf.main`, `create_netcdf.make_netcdf`, and `create_netcdf.make_product_netcdf` functions. The new method will be the default option in 2.4.0, and the old method removed from 2.5.0.

This led to the need for a deprecation policy, which has been added to the documentation, along with a revision history starting with 2.3.0; this may later be backfilled.

Other highlights include:
- changing supported python versions from 3.7-3.11 to 3.8-3.12
- raising errors (with option to warn instead) when trying to add invalid flag values to quality control variables
- option to use locally saved tsv files

What's Changed
* Changes and updates for 2.3 by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/107
* use locally saved tsv files https://github.com/joshua-hampton/ncas_amof_netcdf_template/issues/91
* error or warn if adding invalid QC flag data https://github.com/joshua-hampton/ncas_amof_netcdf_template/issues/103
* keep netCDF file open after creation https://github.com/joshua-hampton/ncas_amof_netcdf_template/issues/104
* bug fix that stopped empty QC variables being removed https://github.com/joshua-hampton/ncas_amof_netcdf_template/issues/105
* changes to documentation including addition of new history and deprecation page https://github.com/joshua-hampton/ncas_amof_netcdf_template/issues/106


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

Release notes
Fix a few bugs as mentioned in issues 97 and 98, looking at dimensions that have a length defined by the standard and dealing with the existence of multiple variables with the same name.
Removal of Python 3.7 checking delayed to release of version 2.3.0.

What's Changed
* Bug fixes by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/99


**Full Changelog**: https://github.com/joshua-hampton/ncas_amof_netcdf_template/compare/2.2.1...2.2.2

Release notes
Small change to checking variable attributes have a value, now checking that they are a string first before checking to see if they are an empty string (as is the case when they have no value). The latest update to Numpy (v1.25) means that when an array is compared to an empty string, previously a warning was issued which we could safely ignore, now an exception is raised. This release addresses this issue.

Also note, as Python 3.7 has reached end of life, this will be the last release that is tested against Python 3.7. While future releases might continue to work with Python 3.7, this will no longer be required or supported.

What's Changed
* Update README.md by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/87
* Check variable attribute value is string before comparing it to a string by joshua-hampton in https://github.com/joshua-hampton/ncas_amof_netcdf_template/pull/93


**Full Changelog**: https://github.com/joshua-hampton/ncas_amof_netcdf_template/compare/2.2.0...2.2.1