Numpy docstrings api

.azure-pipelines/azure-pipelines-linux.yml

@@ -26,7 +26,7 @@ jobs:
   - script: |
       eval "$(conda shell.bash hook)"
       conda activate test
-      conda install --yes --quiet -c conda-forge numpy scipy matplotlib cython vtk properties vectormath pyvista pymatsolver
+      conda install --yes --quiet -c conda-forge numpy scipy matplotlib cython vtk pyvista pymatsolver graphviz
       pip install -r requirements_dev.txt
       pip install -e .
     displayName: Install requirements and build
@@ -43,7 +43,7 @@ jobs:
   - script: |
       eval "$(conda shell.bash hook)"
       conda activate test
-      conda install --yes --quiet -c conda-forge numpy scipy matplotlib cython vtk properties vectormath pyvista pymatsolver
+      conda install --yes --quiet -c conda-forge numpy scipy matplotlib cython vtk pyvista pymatsolver graphviz
       conda install --yes --quiet -c conda-forge pytest pytest-cov
       pip install -r requirements_dev.txt
       pip install pytest-azurepipelines

.azure-pipelines/azure-pipelines-osx.yml

@@ -26,7 +26,7 @@ jobs:
   - script: |
       eval "$(conda shell.bash hook)"
       conda activate test
-      conda install --yes --quiet -c conda-forge numpy scipy matplotlib">=3.0.0" cython vtk properties vectormath pyvista pymatsolver
+      conda install --yes --quiet -c conda-forge numpy scipy matplotlib">=3.0.0" cython vtk pyvista pymatsolver graphviz
       conda install --yes --quiet -c conda-forge pytest
       pip install -r requirements_dev.txt
       pip install pytest-azurepipelines

.azure-pipelines/azure-pipelines-win.yml

@@ -17,7 +17,7 @@ jobs:
     displayName: Add conda to PATH
 
   - script: |
-      conda create --yes --quiet -c conda-forge --name test python=$(python.version) numpy scipy matplotlib cython vtk properties vectormath pyvista pymatsolver pip
+      conda create --yes --quiet -c conda-forge --name test python=$(python.version) numpy scipy matplotlib cython vtk pyvista pymatsolver pip
     displayName: Create Anaconda environment
 
   - script: |

README.rst

@@ -5,15 +5,19 @@ discretize
     :target: https://pypi.python.org/pypi/discretize
     :alt: Latest PyPI version
 
+.. image:: https://anaconda.org/conda-forge/discretize/badges/version.svg
+    :target: https://anaconda.org/conda-forge/discretize
+    :alt: Latest conda-forge version
+
 .. image:: https://img.shields.io/github/license/simpeg/simpeg.svg
-    :target: https://github.com/simpeg/discretize/blob/master/LICENSE
+    :target: https://github.com/simpeg/discretize/blob/main/LICENSE
     :alt: MIT license
 
-.. image:: https://dev.azure.com/simpeg/discretize/_apis/build/status/simpeg.discretize?branchName=master
-    :target: https://dev.azure.com/simpeg/discretize/_build/latest?definitionId=1&branchName=master
+.. image:: https://dev.azure.com/simpeg/discretize/_apis/build/status/simpeg.discretize?branchName=main
+    :target: https://dev.azure.com/simpeg/discretize/_build/latest?definitionId=1&branchName=main
     :alt: Azure pipelines build status
 
-.. image:: https://codecov.io/gh/simpeg/discretize/branch/master/graph/badge.svg
+.. image:: https://codecov.io/gh/simpeg/discretize/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/simpeg/discretize
     :alt: Coverage status
 

azure-pipelines.yml

@@ -48,7 +48,7 @@ stages:
             eval "$(conda shell.bash hook)"
             conda activate test
             conda env list
-            conda install --yes --quiet -c conda-forge numpy scipy matplotlib cython vtk properties vectormath pyvista
+            conda install --yes --quiet -c conda-forge numpy scipy matplotlib cython vtk properties vectormath pyvista graphviz
             pip install -r requirements_dev.txt
             pip install .
           displayName: building and installing deps
@@ -95,6 +95,8 @@ stages:
             python.version: '3.7'
           win-Python38:
             python.version: '3.8'
+          win-Python39:
+            python.version: '3.9'
       pool:
         vmImage: vs2017-win2016
       steps:

discretize/__init__.py

@@ -1,3 +1,34 @@
+"""
+=====================================
+Discretize Meshes (:mod:`discretize`)
+=====================================
+.. currentmodule:: discretize
+
+The ``discretize`` package contains four types of meshes for soliving partial differential
+equations using the finite volume method.
+
+Mesh Classes
+============
+.. autosummary::
+  :toctree: generated/
+
+  TensorMesh
+  CylindricalMesh
+  CurvilinearMesh
+  TreeMesh
+
+Tree Mesh Cells
+===============
+The :class:`~discretize.tree_mesh.TreeCell` class was designed specificialy to define the cells within tree meshes.
+Instances of :class:`~discretize.tree_mesh.TreeCell` are not meant to be created on there own.
+However, they can be returned directly by indexing a particular cell within a tree mesh.
+
+.. autosummary::
+  :toctree: generated/
+
+  tree_mesh.TreeCell
+"""
+
 from discretize.tensor_mesh import TensorMesh
 from discretize.cylindrical_mesh import CylMesh, CylindricalMesh
 from discretize.curvilinear_mesh import CurvilinearMesh