v0.6.5

v0.6.5 (2021-06-10)

New Features

• New optional dependency PyGEOS, when installed the performance of core.subset.create_mask and cure.subset.subset_shape are greatly improved.

v0.6.4

v0.6.4 (2021-05-17)

Breaking Changes

• Exception raised in core.average.average_over_dims when dims is None.
• Exception raised in core.average.average_over_shape when grid and polygon have no overlapping values.

New Features

• ops.subset.subset now ensures all latitude and longitude bounds are in ascending order before passing to core.subset.subset_bbox
• core.subset.subset_level now checks that the order of the bounds matches the order of the level data.
• core.subset._check_desc_coords now checks the bounds provided are ascending before flipping them.

Other Changes

• clisops logging no longer disables other loggers.
• GitHub CI now leverages tox for testing as well as tests averaging functions via a conda-based build.
• Added a CI build to run against xarray@master that is allowed to fail.

v0.6.3

v0.6.3 (2021-03-30)

Breaking Changes

• Raise an exception in core.subset.subset_bbox when there are no data points in the result.
• roocs-utils>=0.6.3 required.

Bug Fixes

• In core.subset.check_start_end_dates check if start and end date requested exist in the calendar of the dataset. If not, nudge the date forward if start date or backwards if end date.

Other Changes

• Error message improved to include longitude bounds of the dataset when the bounds requested in ops.subset.subset are not within range and rolling could not be completed.

v0.6.2

v0.6.2 (2021-03-22)

Bug Fixes

• Better support for disjoint shapes in subset_shape.
• Identify latitude and longitude using cf-xarray rather than by "lat" and "lon"

New Features

• Add output_staging_dir option in etc/roocs.ini, to write files to initially before moving them to the requested output_dir.
• Notebook of examples for average over dims operation added.

v0.6.1

v0.6.1 (2021-02-23)

Bug Fixes

• Add cf-xarray as dependency. This is a dependency of roocs-utils>=0.2.1 so is not a breaking change.
• Remove python-dateutil, fiona and geojson as dependencies, no longer needed.

v0.6.0

v0.6.0 (2021-02-22)

Breaking Changes

• New dev dependency: GitPython==3.1.12

New Features

• average_over_dims added into average.core and average.ops
• New core.average.average_shape + core.subset.subset_create_weight_masks. Depends on xESMF >= 0.5.2, which is a new optional dependency.

Bug Fixes

• Fixed issue where the temporal subset was ignored if level subset selected.
• Roll dataset used in subsetting when the requested longitude bounds are not within those of the dataset.
• Fixed issue with subsetting grid lon and lat coordinates that are in descending order for core.subset.subset_bbox.

Other Changes

• Changes to allow datasets without a time dimension to be processed without issues.
• Use DatasetMapper from roocs-utils to ensure all datasets are mapped to file paths correctly.
• Using file caching to gather mini-esgf-data test data.
• Added a dev recipe for pip installations (pip install clisops[dev]).
• Updated pre-commit and pre-commit hooks to newest versions.
• Migrated linux-based integration builds to GitHub CI.
• Added functionality to core.subset.create_mask so it can accept GeoDataFrames with non-integer indexes.
• clisops.utils.file_namers adjusted to allow values to be overwritten and extras to be added to the end before the file extension.

v0.5.1

v0.5.1 (2020-01-11)

Breaking Changes

• Reverting breaking changes made by the change to core.subset.create_mask. This change introduces a
  second evaluation for shapes touching grid-points.

Other Changes

• Using file caching to gather xclim test data.
• Change made to core.subset.subset_bbox._check_desc_coords to cope with subsetting when only one latitude or
  longitude exists in the input dataset

v0.5.0

v0.5.0 (2020-12-17)

Breaking Changes

• Moved core.subset.create_mask_vectorize to core.subset.create_mask. The old spatial join option was removed.
  core.subset.subset_shape lost its vectorize kwarg, as it is now default.
• roocs-utils>=0.1.5 used

Other Changes

• udunits2>=2.2 removed as a requirement to make clisops completely pip installable.
• rtee and libspatialindex removed as requirements, making it easier to install through pip.
• Static types updated to include missing but permitted types.
• Better handling for paths in ops.subset allowing windows build to be fixed.

v0.4.0

v0.4.0 (2020-11-5)

Adding new features, updating doc strings and documentation and inclusion of static type support.

Breaking Changes

• clisops now requires udunits2>=2.2.
• roocs-utils>=0.1.4 is now required.
• space parameter of clisops.ops.subset renamed to area.
• chunk_rules parameter of clisops.ops.subset renamed to split_method.
• filenamer parameter of clisops.ops.subset renamed to file_namer.

New Features

• subset_level added.
• PR template.
• Config file now exists at clisops.etc.roocs.ini. This can be overwritten by setting the environment variable
  ROOCS_CONFIG to the file path of a config file.
• Static typing added to subset operation function.
• info and debugging are now logged rather than printed.
• Notebook of examples for subset operation added.
• split_method implemented to split output files by if they exceed the memory limit provided in
  clisops.etc.roocs.ini named file_size_limit.
  Currently only the time:auto exists which splits evenly on time ranges.
• file_namer implemented in clisops.ops.subset. This has simple and standard options.
  simple numbers output files whereas standard names them according to the input dataset.
• Memory usage when completing the subsetting operation is now managed using dask chunking. The memory limit for
  memory usage for this process is set in clisops.etc.roocs.ini under chunk_memory_limit.

Bug Fixes

• Nudging time values to nearest available in dataset to fix a bug where subsetting failed when the exact date
  did not exist in the dataset.

Other Changes

• cfunits dependency removed - not needed.
• requirements.txt and environment.yml synced.
• Documentation updated to include API.
• Read the docs build now tested in CI pipeline.
• md files changed to rst.
• tests now use mini-esgf-data by default.

v0.3.1

v0.3.1 (2020-08-04)

Other Changes

• Add missing rtree dependency to ensure correct spatial indexing.