Merge pull request #52 from andrewdnolan/contouring

Implement cell contouring on the native mesh

Author: andrewdnolan

dev-environment.txt

@@ -15,6 +15,8 @@ xarray
 # Development
 click
 jupyterlab
+hyperfine
+line_profiler
 mpas_tools
 
 # Building
@@ -27,7 +29,9 @@ pytest-timeout
 isort
 flake8
 mypy
+networkx
 pre-commit
+hypothesis
 
 # Documentation
 ipywidgets

docs/conf.py

@@ -51,6 +51,7 @@ def setup(app):
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx_remove_toctrees",
+    "matplotlib.sphinxext.roles",
 ]
 
 source_suffix = {
@@ -106,6 +107,7 @@ def setup(app):
 napoleon_google_docstring = False
 napoleon_numpy_docstring = True
 napoleon_preprocess_types = True
+napoleon_use_param = False
 napoleon_type_aliases = {
     "cartopy.crs.Projection": ":class:`cartopy.crs.CRS`",
     # objects without namespace: xarray

docs/developers_guide/api.md

@@ -10,34 +10,23 @@ API Reference
 
 This page provides an auto-generated summary of mosaic's API.
 
-Top Level Utilities
--------------------
+Plotting
+--------
 .. autosummary::
     :toctree: generated/
 
     polypcolor
-    Descriptor
-    datasets.open_dataset
+    contour
+    contourf
 
-Descriptor
-----------
+Data Structures
+---------------
 
-Constructor
-~~~~~~~~~~~
 .. autosummary::
     :toctree: generated/
 
     Descriptor
-
-Properties
-~~~~~~~~~~
-.. autosummary::
-    :toctree: generated/
-
-    Descriptor.cell_patches
-    Descriptor.edge_patches
-    Descriptor.vertex_patches
-    Descriptor.transform
+    mosaic.contour.MPASContourSet
 
 Helper Functions
 ----------------
@@ -47,4 +36,5 @@ Helper Functions
     utils.cull_mesh
     utils.get_invalid_patches
     utils.compute_cell_centroid
+    datasets.open_dataset
 ```

docs/developers_guide/design_docs.md

@@ -0,0 +1,13 @@
+# Design Documents
+
+The pages contained within are intended to serve as somewhere between true "design documents"
+and a collection of notes taken *during* development. The hybrid nature of these notes is
+intended to document the decisions made during development and the test problems used to inform
+those decisions.
+
+```{toctree}
+:maxdepth: 1
+:caption: Design Documents:
+
+design_docs/contouring
+```