update tools sub-module

README.md

@@ -103,5 +103,4 @@ You can contact us via <info@geostat-framework.org>.
 [MIT][mit_link] © 2019
 
 [mit_link]: https://github.com/GeoStat-Framework/AnaFlow/blob/master/LICENSE
-[ogs5_link]: https://www.opengeosys.org/ogs-5/
 [doc_link]: https://geostat-framework.readthedocs.io/projects/anaflow/en/latest/

anaflow/tools/__init__.py

@@ -12,5 +12,78 @@
     mean
     special
     coarse_graining
+
+Functions
+^^^^^^^^^
+
+Annular mean
+~~~~~~~~~~~~
+
+.. currentmodule:: anaflow.tools.mean
+
+Functions to calculate dimension dependent annular means of a function.
+
+.. autosummary::
+   annular_fmean
+   annular_amean
+   annular_gmean
+   annular_hmean
+   annular_pmean
+
+Coarse Graining solutions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. currentmodule:: anaflow.tools.coarse_graining
+
+Effective Coarse Graining conductivity/transmissivity solutions.
+
+.. autosummary::
+   T_CG
+   K_CG
+   TPL_CG
+
+Special
+~~~~~~~
+
+.. currentmodule:: anaflow.tools.coarse_graining
+
+Special functions.
+
+.. autosummary::
+   specialrange
+   specialrange_cut
+   neuman2004_trans
+   aniso
+
 """
 from __future__ import absolute_import
+
+from anaflow.tools.mean import (
+    annular_fmean,
+    annular_amean,
+    annular_gmean,
+    annular_hmean,
+    annular_pmean,
+)
+from anaflow.tools.special import (
+    specialrange,
+    specialrange_cut,
+    neuman2004_trans,
+    aniso,
+)
+from anaflow.tools.coarse_graining import T_CG, K_CG, TPL_CG
+
+__all__ = [
+    "annular_fmean",
+    "annular_amean",
+    "annular_gmean",
+    "annular_hmean",
+    "annular_pmean",
+    "specialrange",
+    "specialrange_cut",
+    "neuman2004_trans",
+    "aniso",
+    "T_CG",
+    "K_CG",
+    "TPL_CG",
+]