Merge pull request #57 from roocs/release-0.2.0

Changes to HISTORY etc. for release 0.2.0

HISTORY.rst

@@ -1,6 +1,32 @@
 Version History
 ===============
 
+v0.2.0 (2021-02-18)
+-------------------
+
+Breaking Changes
+^^^^^^^^^^^^^^^^
+* cf_xarray>=0.3.1 now required due to differing level identification of coordinates between versions.
+* oyaml>=0.9 - new dependency for inventory
+* Interface to inventory maker changed. Detailed instructions for use added in README.
+* Adjusted file name template. Underscore removed before ``__derive__time_range``
+* New dev dependency: GitPython==3.1.12
+
+New Features
+^^^^^^^^^^^^
+* Added ``use_inventory`` option to ``roocs.ini`` config and allow data to be used without checking an inventory.
+* ``DatasetMapper`` class and wrapper functions added to ``roocs_utils.project_utils`` and ``roocs_utils.xarray_utils.xarray_utils`` to resolve all paths and dataset ids in the same way.
+* ``FileMapper`` added in ``roocs_utils.utils.file_utils`` to resolve resolve multiple files with the same directory to their directory path.
+* Fixed path mapping support added in ``DatasetMapper``
+* Added ``DimensionParameter`` to be used with the average operation.
+
+Other Changes
+^^^^^^^^^^^^^
+* Removed submodule for test data. Test data is now cloned from git using GitPython and cached
+* ``CollectionParamter`` accepts an instance of ``FileMapper`` or a sequence of ``FileMapper`` objects
+* Adjusted file name template to include an ``extra`` option before the file extension.
+* Swapped from travis CI to GitHub actions
+
 v0.1.5 (2020-11-23)
 -------------------
 

docs/api.rst

@@ -35,13 +35,29 @@ Parameters
    :undoc-members:
    :show-inheritance:
 
+.. automodule:: roocs_utils.parameter.dimension_parameter
+   :noindex:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 .. automodule:: roocs_utils.parameter.parameterise
    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
 
 
+Project Utils
+=============
+
+.. automodule:: roocs_utils.project_utils
+   :noindex:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
 Xarray Utils
 ============
 
@@ -66,3 +82,9 @@ Other utilities
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. automodule:: roocs_utils.utils.file_utils
+   :noindex:
+   :members:
+   :undoc-members:
+   :show-inheritance:

roocs_utils/inventory/inventory.py

@@ -14,11 +14,11 @@
 
 
 def get_time_info(fpaths, var_id):
-
     all_times = []
     for fpath in sorted(fpaths):
 
         try:
+
             ds = xr.open_dataset(fpath, use_cftime=True)
             times = ds[var_id].time.values
 
@@ -94,9 +94,11 @@ def get_var_metadata(fpaths, var_id):
 
 
 def build_dict(ds_id, proj_dict):
-
     fpaths = DatasetMapper(ds_id).files
 
+    if len(fpaths) < 1:
+        raise FileNotFoundError("No files were found for this dataset")
+
     comps = ds_id.split(".")
 
     facet_rule = proj_dict["facet_rule"]

roocs_utils/project_utils.py

@@ -218,7 +218,6 @@ def get_project_from_ds(ds):
 
 
 def get_project_name(dset):
-
     if type(dset) in (xr.core.dataarray.DataArray, xr.core.dataset.Dataset):
         return get_project_from_ds(dset)  # will not return c3s dataset
 

roocs_utils/xarray_utils/xarray_utils.py

@@ -174,6 +174,7 @@ def get_coord_by_type(ds, coord_type, ignore_aux_coords=True):
     :return: Xarray Dataset coordinate (ds.coords[coord_id])
     """
     "Can take a Dataset or DataArray"
+
     if coord_type not in known_coord_types:
         raise Exception(f"Coordinate type not known: {coord_type}")