add doc files

landlab · Nov 10, 2023 · e428af4 · e428af4
1 parent 3922a36
commit e428af4
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 17 deletions.
diff --git a/docs/source/reference/graph/dual_icosphere.rst b/docs/source/reference/graph/dual_icosphere.rst
@@ -0,0 +1,36 @@
+landlab.graph.quasi_spherical package
+=====================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+
+
+Submodules
+----------
+
+landlab.graph.quasi_spherical.dual_icosphere module
+---------------------------------------------------
+
+.. automodule:: landlab.graph.quasi_spherical.dual_icosphere
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+landlab.graph.quasi_spherical.refinable_icosahedron module
+----------------------------------------------------------
+
+.. automodule:: landlab.graph.quasi_spherical.refinable_icosahedron
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: landlab.graph.quasi_spherical
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/reference/grid/icosphere.rst b/docs/source/reference/grid/icosphere.rst
@@ -0,0 +1,8 @@
+API for landlab.grid.icosphere
+------------------------------
+
+.. automodule:: landlab.grid.icosphere
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/docs/source/reference/grid/index.rst b/docs/source/reference/grid/index.rst
@@ -7,8 +7,8 @@ Landlab Grids
 Grid types
 ----------
 
-Landlab presently supports five types of grids. The base class is ``ModelGrid``
-with subclasses ``RasterModelGrid`` and ``VoronoiDelaunayGrid``.
+Landlab presently supports seven types of grids. The base class is ``ModelGrid``
+with subclasses ``RasterModelGrid``, ``VoronoiDelaunayGrid``, and ``IcosphereGlobalGrid``.
 ``VoronoiDelaunayGrid`` has three further specialized subclasses: ``FramedVoronoiGrid``,
 ``HexModelGrid`` and ``RadialModelGrid``. A final class is ``NetworkModelGrid``.
 
@@ -23,6 +23,7 @@ The following is an introduction to their properties and methods:
    hex
    radial
    network
+   icosphere
 
 
 Additional Methods and Properties
@@ -60,6 +61,7 @@ API for each grid type
    hex
    radial
    network
+   icosphere
 
 Additional Grid Base Classes
 ----------------------------

diff --git a/docs/source/user_guide/grid.rst b/docs/source/user_guide/grid.rst
@@ -547,21 +547,23 @@ As noted earlier, Landlab provides several different types of grid. Available gr
 classes, with more specialized grids inheriting properties and behavior from more
 general types. The class hierarchy is given in the second column, **Inherits from**.
 
-+-------------------------+-------------------------+--------------------+-------------------+
-| Grid type               | Inherits from           | Node arrangement   | Cell geometry     |
-+=========================+=========================+====================+===================+
-| ``RasterModelGrid``     | ``ModelGrid``           | raster             | squares           |
-+-------------------------+-------------------------+--------------------+-------------------+
-| ``VoronoiDelaunayGrid`` | ``ModelGrid``           | Delaunay triangles | Voronoi polygons  |
-+-------------------------+-------------------------+--------------------+-------------------+
-| ``FramedVoronoiGrid``   | ``VoronoiDelaunayGrid`` | Delaunay triangles | Voronoi polygons  |
-+-------------------------+-------------------------+--------------------+-------------------+
-| ``HexModelGrid``        | ``VoronoiDelaunayGrid`` | triagonal          | hexagons          |
-+-------------------------+-------------------------+--------------------+-------------------+
-| ``RadialModelGrid``     | ``VoronoiDelaunayGrid`` | concentric         | Voronoi polygons  |
-+-------------------------+-------------------------+--------------------+-------------------+
-| ``NetworkModelGrid``    | ``ModelGrid``           | ad libitum         | No cells          |
-+-------------------------+-------------------------+--------------------+-------------------+
++-------------------------+-------------------------+--------------------+----------------------+
+| Grid type               | Inherits from           | Node arrangement   | Cell geometry        |
++=========================+=========================+====================+======================+
+| ``RasterModelGrid``     | ``ModelGrid``           | raster             | squares              |
++-------------------------+-------------------------+--------------------+----------------------+
+| ``VoronoiDelaunayGrid`` | ``ModelGrid``           | Delaunay triangles | Voronoi polygons     |
++-------------------------+-------------------------+--------------------+----------------------+
+| ``FramedVoronoiGrid``   | ``VoronoiDelaunayGrid`` | Delaunay triangles | Voronoi polygons     |
++-------------------------+-------------------------+--------------------+----------------------+
+| ``HexModelGrid``        | ``VoronoiDelaunayGrid`` | triagonal          | hexagons             |
++-------------------------+-------------------------+--------------------+----------------------+
+| ``RadialModelGrid``     | ``VoronoiDelaunayGrid`` | concentric         | Voronoi polygons     |
++-------------------------+-------------------------+--------------------+----------------------+
+| ``NetworkModelGrid``    | ``ModelGrid``           | ad libitum         | No cells             |
++-------------------------+-------------------------+--------------------+----------------------+
+| ``IcosphereGlobalGrid`` | ``ModelGrid``           | spherical          | hexagons & pentagons |
++-------------------------+-------------------------+--------------------+----------------------+
 
 :py:class:`landlab.grid.raster.RasterModelGrid <landlab.grid.raster.RasterModelGrid>`
 gives a regular (square) grid, initialized
@@ -579,6 +581,17 @@ regular hexagons.
 In a :py:class:`landlab.grid.radial.RadialModelGrid <landlab.grid.radial.RadialModelGrid>`, nodes are created in concentric
 circles and then connected to
 form a Delaunay triangulation (again with Voronoi polygons as cells).
+:py:class:`landlab.grid.network.NetworkModelGrid` represents a branching network of nodes and links,
+without cells or patches.
+An :py:class:`landlab.grid.icosphere.IcosphereGlobalGrid` represents the surface of a sphere. 
+The default configuration is a spherical grid of unit radius that
+forms the spherical version an icosahedron (20 triangular patches,
+12 nodes), with the dual complement representing a dodecahedron
+(12 hexagonal cells, 20 corners). The mesh_densification_level
+parameter allows you to densify this initial shape by subdividing
+each triangular patch into four triangles, with corresponding
+addition of nodes (as the triangle vertices), together with
+corresponding cells and corners. 
 
 .. _importing_a_dem: