Merge pull request #155 from joshua-hampton/format-instrument-dicts

Replace very nested instrument dictionary with FileInfo class
joshua-hampton · Nov 19, 2024 · 20e623c · 20e623c
2 parents 3808e28 + f4cdd64
commit 20e623c
Show file tree

Hide file tree

Showing 11 changed files with 965 additions and 315 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -7,6 +7,7 @@ API
    :recursive:
 
    ncas_amof_netcdf_template.create_netcdf
+   ncas_amof_netcdf_template.file_info
    ncas_amof_netcdf_template.remove_empty_variables
    ncas_amof_netcdf_template.tsv2dict
    ncas_amof_netcdf_template.util

diff --git a/docs/source/file_info.rst b/docs/source/file_info.rst
@@ -0,0 +1,5 @@
+file_info
+---------
+
+.. automodule:: ncas_amof_netcdf_template.file_info
+    :members:
diff --git a/docs/source/~generated/ncas_amof_netcdf_template.file_info.rst b/docs/source/~generated/ncas_amof_netcdf_template.file_info.rst
@@ -0,0 +1,26 @@
+ncas\_amof\_netcdf\_template.file\_info
+=======================================
+
+.. automodule:: ncas_amof_netcdf_template.file_info
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      convert_instrument_dict_to_file_info
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      FileInfo
diff --git a/docs/source/~generated/ncas_amof_netcdf_template.util.rst b/docs/source/~generated/ncas_amof_netcdf_template.util.rst
@@ -14,6 +14,7 @@
    .. autosummary::
 
       add_metadata_to_netcdf
+      change_qc_flags
       check_float
       check_int
       check_type_convert

diff --git a/docs/source/~generated/ncas_amof_netcdf_template.values.rst b/docs/source/~generated/ncas_amof_netcdf_template.values.rst
@@ -20,3 +20,4 @@
       get_community_instruments_url
       get_instruments_url
       get_latest_CVs_version
+      get_latest_instrument_CVs_version
diff --git a/src/ncas_amof_netcdf_template/__init__.py b/src/ncas_amof_netcdf_template/__init__.py
@@ -4,5 +4,6 @@
 from . import tsv2dict
 from . import util
 from . import values
+from . import file_info
 
 __version__="2.5.0-alpha"