Skip to content

Commit

Permalink
Merge pull request #164 from xylar/update_to_0.3.0
Browse files Browse the repository at this point in the history
Update to v0.3.0
  • Loading branch information
xylar authored Feb 6, 2021
2 parents f2bf645 + f1852fd commit ba787ee
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 2 deletions.
27 changes: 27 additions & 0 deletions docs/aggregation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,33 @@ The :py:mod:`geometric_features.aggregation` module contains functions used to
aggregate existing features to make new, larger ones. An example usage of these
aggregation functions is to create masks for regional averaging.

The function :py:func:`geometric_features.aggregation.get_aggregator_by_name()`
can be used to get information about one of the aggregated features by one of
the following group names:

* Antarctic Regions

* Arctic Ocean Regions

* Arctic Sea Ice Regions

* Ocean Basins

* Ice Shelves

* Ocean Subbasins

* ISMIP6 Regions

* Transport Transects

This function returns the function that will aggregate the requested group,
a prefix for the group (a modified version of the group name) and a date stamp
that is updated each time the features in the group are changed. This way,
mask files can be created from these features with filenames that include the
date stamp. As long as the date stamp has not changed, these cached mask files
can be reused.


Aggregating Ocean Features
--------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ Aggregation
:toctree: generated/

aggregation
aggregation.get_aggregator_by_name
aggregation.ocean
aggregation.ocean.subbasins
aggregation.ocean.basins
Expand Down
3 changes: 3 additions & 0 deletions docs/versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Documentation On GitHub
`v0.1.12`_ `0.1.12`_
`v0.1.13`_ `0.1.13`_
`v0.2.0`_ `0.2.0`_
`v0.3.0`_ `0.3.0`_
================ ===============

.. _`stable`: ../stable/index.html
Expand All @@ -33,3 +34,5 @@ Documentation On GitHub
.. _`0.1.13`: https://github.com/MPAS-Dev/geometric_features/tree/0.1.13
.. _`v0.2.0`: ../0.2.0/index.html
.. _`0.2.0`: https://github.com/MPAS-Dev/geometric_features/tree/0.2.0
.. _`v0.3.0`: ../0.3.0/index.html
.. _`0.3.0`: https://github.com/MPAS-Dev/geometric_features/tree/0.3.0
2 changes: 1 addition & 1 deletion geometric_features/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@
from geometric_features.utils import write_feature_names_and_tags


__version_info__ = (0, 2, 0)
__version_info__ = (0, 3, 0)
__version__ = '.'.join(str(vi) for vi in __version_info__)
2 changes: 1 addition & 1 deletion recipe/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% set name = "geometric_features" %}
{% set version = "0.2.0" %}
{% set version = "0.3.0" %}
{% set build = 0 %}

package:
Expand Down

0 comments on commit ba787ee

Please sign in to comment.