Zco: More xarray, tests, and improve/expose docstring (#31)

* same as previous PR, but keep track of previous changes * Make tests more trivial and warn when uniform and double tanh * test 999999 == None and final cleanup
pyNEMO · Jun 16, 2021 · 6cf13c5 · 6cf13c5
1 parent db12bd9
commit 6cf13c5
Show file tree

Hide file tree

Showing 11 changed files with 467 additions and 364 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -41,7 +41,7 @@ repos:
     hooks:
       - id: mypy
         exclude: docs
-        additional_dependencies: [types-pkg_resources]
+        additional_dependencies: [xarray, types-pkg_resources]
 
   - repo: https://github.com/PyCQA/doc8
     rev: 0.9.0a1

diff --git a/docs/conf.py b/docs/conf.py
@@ -61,6 +61,9 @@
 # Darglint is already forcing us to have consistent types in the docstring.
 autodoc_typehints = "none"
 
+# Do not warn about missing "Methods" in class docstring
+numpydoc_show_class_members = False
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

diff --git a/docs/developers/whats-new.rst b/docs/developers/whats-new.rst
@@ -8,6 +8,8 @@ Unreleased
 
 - Added :py:func:`~pydomcfg.bathymetry.sea_mount`
   useful to generate classic sea mount test case. (:pr:`17`)
+- Added :py:class:`~pydomcfg.domzgr.zco.Zco`
+  to generate geopotential z-coordinates. (:pr:`15`)
 - Added :py:func:`~pydomcfg.utils.generate_cartesian_grid`
   useful to generate test datasets. (:pr:`8`)
 - pyDOMCFG is on GitHub! (:pr:`1`)
diff --git a/docs/users/api.rst b/docs/users/api.rst
@@ -5,6 +5,17 @@ API reference
 
 This page provides an auto-generated summary of pyDOMCFG's API.
 
+Domzgr
+======
+
+Zco
+----
+.. autoclass:: pydomcfg.domzgr.zco.Zco
+    :members:
+
+    .. automethod:: __init__
+    .. automethod:: __call__
+
 Utils
 =====
 .. autosummary::