doc update

GeoStat-Framework · Jan 21, 2019 · b09bce7 · b09bce7
1 parent f5999d8
commit b09bce7
Show file tree

Hide file tree

Showing 21 changed files with 548 additions and 101 deletions.
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -4,7 +4,7 @@
     {{ super() }}
     <br />
     <p class="link caption"><span class="link caption-text">ogs5py Links</span></p>
-    <a href="https://github.com/GeoStat-Framework/GSTools">ogs5py GitHub</a>
+    <a href="https://github.com/GeoStat-Framework/ogs5py">ogs5py GitHub</a>
     <a href="">ogs5py Zenodo DOI</a>
     <a href="">ogs5py PyPI</a>
     <br />

diff --git a/docs/source/fileclasses.base.rst b/docs/source/fileclasses.base.rst
@@ -0,0 +1,11 @@
+ogs5py.fileclasses.base
+=======================
+
+.. automodule:: ogs5py.fileclasses.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/fileclasses.rst b/docs/source/fileclasses.rst
@@ -1,2 +1,13 @@
-File-Classes
-============
+ogs5py.fileclasses
+==================
+
+.. automodule:: ogs5py.fileclasses
+
+.. raw:: latex
+
+    \clearpage
+
+.. toctree::
+   :hidden:
+
+   fileclasses.base.rst
diff --git a/docs/source/ogs_base.rst b/docs/source/ogs_base.rst
@@ -1,2 +1,11 @@
-OGS Base Class
-==============
+ogs5py.ogs
+==========
+
+.. automodule:: ogs5py.ogs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/reader.rst b/docs/source/reader.rst
@@ -1,2 +1,11 @@
-Reader
-======
+ogs5py.reader
+=============
+
+.. automodule:: ogs5py.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/tools.rst b/docs/source/tools.rst
@@ -1,2 +1,15 @@
-Tools
-=====
+ogs5py.tools
+============
+
+.. automodule:: ogs5py.tools
+
+.. raw:: latex
+
+    \clearpage
+
+.. toctree::
+   :hidden:
+
+   tools.tools.rst
+   tools.script.rst
+   tools.types.rst
diff --git a/docs/source/tools.script.rst b/docs/source/tools.script.rst
@@ -0,0 +1,11 @@
+ogs5py.tools.script
+===================
+
+.. automodule:: ogs5py.tools.script
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/tools.tools.rst b/docs/source/tools.tools.rst
@@ -0,0 +1,11 @@
+ogs5py.tools.tools
+==================
+
+.. automodule:: ogs5py.tools.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/tools.types.rst b/docs/source/tools.types.rst
@@ -0,0 +1,11 @@
+ogs5py.tools.types
+==================
+
+.. automodule:: ogs5py.tools.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
diff --git a/ogs5py/__init__.py b/ogs5py/__init__.py
@@ -1,34 +1,79 @@
 """
-ogs5py Python Package
-
-Get help on each function by typing
-
->>> import ogs5py
->>> help(ogs5py.function)
-
-BC  - Boundary Condition
-CCT - Communication Table
-FCT - Function
-GEM - geochemical thermodynamic modeling coupling
-GLI - Geometry
-IC  - Initial Condition
-KRC - Kinetric Reaction
-MCP - reactive components for modelling chemical processes
-MFP - Fluid Properties
-MMP - Medium Properties
-MPD - Distributed Properties
-MSH - Mesh
-MSP - Solid Properties
-NUM - Settings for the numerical solver
-OUT - Output Settings
-PCS - Process settings
-PQC - Phreqqc coupling (just a line-wise file with no comfort)
-REI - Reaction Interface
-RFD - definition of time-curves for variing BCs or STs
-ST  - Source Term
-TIM - Time settings
-"""
+Purpose
+=======
+
+ogs5py is A python-API for the OpenGeoSys 5 scientific modeling package.
+
+The following functionalities are directly provided on module-level.
+
+Subpackages
+===========
+
+.. autosummary::
+    fileclasses
+    reader
+    tools
+
+Classes
+=======
+
+OGS model Base Class
+^^^^^^^^^^^^^^^^^^^^
+Class to setup an ogs model
+
+.. currentmodule:: ogs5py.ogs
 
+.. autosummary::
+   OGS
+
+File Classes
+^^^^^^^^^^^^
+Classes for all OGS5 Files
+
+.. currentmodule:: ogs5py.fileclasses
+
+.. autosummary::
+   ASC
+   BC
+   CCT
+   DDC
+   FCT
+   GEM
+   GEMinit
+   GLI
+   GLIext
+   IC
+   RFR
+   KRC
+   MCP
+   MFP
+   MMP
+   MPD
+   MSH
+   MSP
+   NUM
+   OUT
+   PCS
+   PCT
+   PQC
+   PQCdat
+   REI
+   RFD
+   ST
+   TIM
+
+Functions
+=========
+
+Searching
+^^^^^^^^^
+Routine to search for a valid ogs id in a directory
+
+.. currentmodule:: ogs5py.tools.tools
+
+.. autosummary::
+   search_task_id
+"""
 from __future__ import absolute_import
 
 from ogs5py._version import __version__

diff --git a/ogs5py/fileclasses/__init__.py b/ogs5py/fileclasses/__init__.py
@@ -1,6 +1,50 @@
+# -*- coding: utf-8 -*-
 """
-OGS Python Package
-File classes
+ogs5py subpackage providing the file classes
+
+.. currentmodule:: ogs5py.fileclasses
+
+Subpackages
+^^^^^^^^^^^
+
+.. autosummary::
+    base
+
+File Classes
+^^^^^^^^^^^^
+Classes for all OGS5 Files
+
+.. autosummary::
+   ASC
+   BC
+   CCT
+   DDC
+   FCT
+   GEM
+   GEMinit
+   GLI
+   GLIext
+   IC
+   RFR
+   KRC
+   MCP
+   MFP
+   MMP
+   MPD
+   MSH
+   MSP
+   NUM
+   OUT
+   PCS
+   PCT
+   PQC
+   PQCdat
+   REI
+   RFD
+   ST
+   TIM
+
+----
 """
 from __future__ import absolute_import
 

diff --git a/ogs5py/fileclasses/base.py b/ogs5py/fileclasses/base.py
@@ -1,7 +1,18 @@
-#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
 Base Classes for the OGS Files
+
+.. currentmodule:: ogs5py.fileclasses.base
+
+File Class
+^^^^^^^^^^
+
+.. autosummary::
+   File
+   LineFile
+   BlockFile
+
+----
 """
 from __future__ import print_function, division, absolute_import
 import os

diff --git a/ogs5py/fileclasses/ddc/core.py b/ogs5py/fileclasses/ddc/core.py
@@ -34,8 +34,8 @@ class DDC(BlockFile):
     Standard block:
         None
 
-    Info
-    ----
+    See Also
+    --------
     See: ``add_block``
 
     https://github.com/ufz/ogs5/blob/master/FEM/par_ddc.cpp

diff --git a/ogs5py/fileclasses/ic/core.py b/ogs5py/fileclasses/ic/core.py
@@ -44,8 +44,8 @@ class IC(BlockFile):
         :GEO_TYPE: "DOMAIN"
         :DIS_TYPE: ["CONSTANT", 0.0]
 
-    Info
-    ----
+    See Also
+    --------
     See: ``add_block``
 
     https://ogs5-keywords.netlify.com/ogs/wiki/public/doc-auto/by_ext/ic