chore: bump version to 2.1.7 (#350)

* docs: add `CITATION.cff`
* docs: update `environment.yml` to include `netCDF4`

CITATION.cff

@@ -0,0 +1,44 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: pyTMD
+message: Python-based tidal prediction software
+type: software
+authors:
+  - given-names: Tyler
+    family-names: Sutterley
+    affiliation: University of Washington, Applied Physics Laboratory
+  - given-names: Karen
+    family-names: Alley
+    affiliation: University of Manitoba
+  - given-names: Robbi
+    family-names: Bishop-Taylor
+    affiliation: Geoscience Australia
+  - given-names: Kelly
+    family-names: Brunt
+    affiliation: NASA Goddard Space Flight Center
+  - given-names: Susan
+    family-names: Howard
+    affiliation: Earth & Space Research
+  - given-names: Laurie
+    family-names: Padman
+    affiliation: Earth & Space Research
+  - given-names: Matthew
+    family-names: Siegfried
+    affiliation: Colorado School of Mines
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.5555395
+    description: Zenodo Archive
+repository-code: 'https://github.com/tsutterley/pyTMD'
+url: 'https://pytmd.readthedocs.io'
+repository: 'https://pypi.org/project/pyTMD'
+repository-artifact: 'https://anaconda.org/conda-forge/pytmd'
+keywords:
+  - Ocean Tides
+  - Load Tides
+  - Pole Tides
+  - Solid Earth Tides
+  - Tidal Prediction
+license: MIT

doc/environment.yml

@@ -7,6 +7,7 @@ dependencies:
   - freetype
   - graphviz
   - lxml
+  - netCDF4
   - numpy
   - numpydoc
   - pip

doc/source/getting_started/Glossary.rst

@@ -68,6 +68,11 @@ Glossary
     Equinox
         the ascending node of the Earth's orbit about the sun, and the point on the equatorial plane where it meets the ecliptic plane
 
+    Free Core Nutation
+        Nearly diurnal deviations in the motion of the pole of rotation due to the resonant motion of the Earth's core relative to the mantle
+
+        see :term:`Nutation`
+
     Frequency
         number of cycles in a unit time
 

doc/source/release_notes/release-v2.1.7.rst

@@ -0,0 +1,27 @@
+##################
+`Release v2.1.7`__
+##################
+
+* ``docs``: improve description of optional dependencies in examples
+* ``fix``: use case insensitive assertions of string argument values (`#340 <https://github.com/tsutterley/pyTMD/pull/340>`_)
+* ``feat``: added bounded options for least squares solvers (`#341 <https://github.com/tsutterley/pyTMD/pull/341>`_)
+* ``feat``: add ``__models__`` with all model names in database (`#341 <https://github.com/tsutterley/pyTMD/pull/341>`_)
+* ``feat``: add function lists as ``__all__`` (`#341 <https://github.com/tsutterley/pyTMD/pull/341>`_)
+* ``feat``: add `Ray and Erofeeva (2014) <https://doi.org/10.1002/2013JB010830>`_ to the database for `#327 <https://github.com/tsutterley/pyTMD/issues/327>`_ (`#341 <https://github.com/tsutterley/pyTMD/pull/341>`_)
+* ``feat``: add minor inference for long period tides to address `#327 <https://github.com/tsutterley/pyTMD/issues/327>`_ (`#342 <https://github.com/tsutterley/pyTMD/pull/342>`_)
+* ``fix``: try inferring both long and short period tides for FES (`#343 <https://github.com/tsutterley/pyTMD/pull/343>`_)
+* ``refactor``: using new JSON dictionary format for model projections for `#333 <https://github.com/tsutterley/pyTMD/issues/333>`_ (`#345 <https://github.com/tsutterley/pyTMD/pull/345>`_)
+* ``docs``: add notebook with a cotidal chart for `#344 <https://github.com/tsutterley/pyTMD/issues/344>`_ and `#348 <https://github.com/tsutterley/pyTMD/discussions/348>`_ (`#345 <https://github.com/tsutterley/pyTMD/pull/345>`_)
+* ``docs``: update descriptions of coordinate reference systems
+* ``feat``: add new functions to infer semi-diurnal and diurnal tides (`#346 <https://github.com/tsutterley/pyTMD/pull/346>`_)
+* ``feat``: use PREM as the default Earth model for Love numbers (`#347 <https://github.com/tsutterley/pyTMD/pull/347>`_)
+* ``feat``: compute delta times based on corrections type (`#347 <https://github.com/tsutterley/pyTMD/pull/347>`_)
+* ``feat``: add wrapper functions to read and interpolate constants (`#349 <https://github.com/tsutterley/pyTMD/pull/349>`_)
+* ``tests``: use simplified wrapper functions (`#349 <https://github.com/tsutterley/pyTMD/pull/349>`_)
+* ``feat``: updated computation of long-period equilibrium tides (`#349 <https://github.com/tsutterley/pyTMD/pull/349>`_)
+* ``feat``: add functions to append node tide equilibrium values to amplitudes (`#349 <https://github.com/tsutterley/pyTMD/pull/349>`_)
+* ``fix``: add messaging if there are no minor constituents to infer (`#349 <https://github.com/tsutterley/pyTMD/pull/349>`_)
+* ``feat``: can convert Doodson numbers formatted as strings (`#349 <https://github.com/tsutterley/pyTMD/pull/349>`_)
+* ``docs``: expand the glossary (`#349 <https://github.com/tsutterley/pyTMD/pull/349>`_)
+
+.. __: https://github.com/tsutterley/pyTMD/releases/tag/2.1.7

pyTMD/io/constituents.py

@@ -226,9 +226,10 @@ def parse(constituent: str) -> str:
             'm1','chi1','pi1','p1','s1','k1','psi1','phi1','beta1','theta1','j1',
             'oo1','2n2','mu2',r'(?<!2)n2','nu2',r'(?<!2s)m2(?!a)(?!b)',
             'm2a','m2b','lambda2','l2','t2',r'(?<!mn)(?<!mk)(?<!ep)s2(?!0)',
-            'alpha2','beta2','delta2','r2','k2',r'(?<!b)eta2','mns2','2sm2','m3',
-            'mk3','s3','mn4','m4','ms4','mk4','so1',r'(?<!m)s4','s5','m6','s6',
-            's7','s8','m8','mks2','msqm','mtm',r'(?<!m)n4','eps2','ups1','z0','node']
+            'alpha2','beta2','delta2','gamma2','r2','k2',r'(?<!b)eta2',
+            'mns2','2sm2','m3','mk3','s3','mn4','m4','ms4','mk4','so1',
+            r'(?<!m)s4','s5','m6','s6','s7','s8','m8','mks2','msqm','mtm',
+            r'(?<!m)n4','eps2','ups1','z0','node']
         # compile regular expression
         # adding GOT prime nomenclature for 3rd degree constituents
         rx = re.compile(r'(' + '|'.join(cindex) + r')(\')?', re.IGNORECASE)

version.txt

@@ -1 +1 @@
-2.1.6
+2.1.7