rename submodule ext_grf

GeoStat-Framework · Aug 7, 2019 · c8f0706 · c8f0706
1 parent 9cc0011
commit c8f0706
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 20 deletions.
diff --git a/anaflow/__init__.py b/anaflow/__init__.py
@@ -50,7 +50,7 @@
 Extended GRF
 ^^^^^^^^^^^^
 
-.. currentmodule:: anaflow.flow.ext_grf
+.. currentmodule:: anaflow.flow.ext_grf_model
 
 The extended general radial flow model.
 

diff --git a/anaflow/flow/__init__.py b/anaflow/flow/__init__.py
@@ -10,7 +10,7 @@
 .. autosummary::
     homogeneous
     heterogeneous
-    ext_grf
+    ext_grf_model
     laplace
 
 Solutions
@@ -50,7 +50,7 @@
 Extended GRF
 ~~~~~~~~~~~~
 
-.. currentmodule:: anaflow.flow.ext_grf
+.. currentmodule:: anaflow.flow.ext_grf_model
 
 The extended general radial flow model.
 
@@ -73,7 +73,7 @@
     neuman2004,
     neuman2004_steady,
 )
-from anaflow.flow.ext_grf import ext_grf, ext_grf_steady
+from anaflow.flow.ext_grf_model import ext_grf, ext_grf_steady
 
 __all__ = [
     "thiem",

diff --git a/anaflow/flow/ext_grf.py → anaflow/flow/ext_grf_model.py b/anaflow/flow/ext_grf.py → anaflow/flow/ext_grf_model.py
@@ -2,7 +2,7 @@
 """
 Anaflow subpackage providing the extended GRF Model.
 
-.. currentmodule:: anaflow.flow.ext_grf
+.. currentmodule:: anaflow.flow.ext_grf_model
 
 The following functions are provided
 

diff --git a/anaflow/flow/heterogeneous.py b/anaflow/flow/heterogeneous.py
@@ -36,7 +36,7 @@
     TPL_CG,
     TPL_CG_error,
 )
-from anaflow.flow.ext_grf import ext_grf, ext_grf_steady
+from anaflow.flow.ext_grf_model import ext_grf, ext_grf_steady
 
 __all__ = [
     "ext_thiem_2d",

diff --git a/anaflow/flow/homogeneous.py b/anaflow/flow/homogeneous.py
@@ -17,7 +17,7 @@
 import numpy as np
 
 from anaflow.tools.special import well_solution, grf_solution
-from anaflow.flow.ext_grf import ext_grf, ext_grf_steady
+from anaflow.flow.ext_grf_model import ext_grf, ext_grf_steady
 
 __all__ = ["thiem", "theis", "grf"]
 

diff --git a/docs/source/flow.ext_grf.rst b/docs/source/flow.ext_grf.rst
diff --git a/docs/source/flow.ext_grf_model.rst b/docs/source/flow.ext_grf_model.rst
@@ -0,0 +1,11 @@
+anaflow.flow.ext_grf_model
+==========================
+
+.. automodule:: anaflow.flow.ext_grf_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/flow.rst b/docs/source/flow.rst
@@ -12,5 +12,5 @@ anaflow.flow
 
    flow.homogeneous.rst
    flow.heterogeneous.rst
-   flow.ext_grf.rst
+   flow.ext_grf_model.rst
    flow.laplace.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -36,7 +36,7 @@ The following functions are provided directly
 * :any:`neuman2004` transient solution from *Neuman 2004*
 * :any:`neuman2004_steady` steady solution from *Neuman 2004*
 * :any:`grf` "General Radial Flow" Model from *Barker 1988*
-* :py:func:`ext_grf` the transient extended GRF model
+* :any:`ext_grf` the transient extended GRF model
 * :any:`ext_grf_steady` the steady extended GRF model
 * :any:`ext_thiem_tpl` extended Thiem solution for truncated power laws
 * :any:`ext_theis_tpl` extended Theis solution for truncated power laws