first version of the docs

Author: MuellerSeb

LICENSE

@@ -1,47 +1,32 @@
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-
-Welcome to ogs5py
-=================
-
-Purpose
--------
-ogs5py is A python-API for the OpenGeoSys 5 scientific modeling package.
-
-
-Installation
-------------
-You can install the latest version with the following command:
-
-    pip install https://github.com/GeoStat-Framework/ogs5py/archive/master.zip
+# Welcome to ogs5py
 
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
-Contents
---------
-With ogs5py you can setup, control and start an OGS5 model within python.
+<p align="center">
+<img src="https://raw.githubusercontent.com/GeoStat-Framework/ogs5py/master/docs/source/pics/OGS.png" alt="ogs5py-LOGO" width="251px"/>
+</p>
 
-It comes along with a set of handy readers for almost all output formats:
+## Purpose
 
-* VTK Domain output
+ogs5py is A python-API for the [OpenGeoSys 5][ogs5_link] scientific modeling package.
 
-        ogs5py.reader.readvtk
 
-* PVD Domain output
+## Installation
 
-        ogs5py.reader.readpvd
+You can install the latest version with the following command:
 
-* TECPLOT point output
+    pip install https://github.com/GeoStat-Framework/ogs5py/archive/master.zip
 
-        ogs5py.reader.readtec_point
 
-* TECPLOT polyline output
+## Documentation for ogs5py
 
-        ogs5py.reader.readtec_polyline
+You can find the documentation under (...will follow soon...)
 
 
-Example
--------
+### Tutorials and Examples
 
-In the following a simple transient pumping test is simulated on a radial symmetric mesh. The point output at the observation well is plotted afterwards.
+In the following a simple transient pumping test is simulated on a radial symmetric mesh.
+The point output at the observation well is plotted afterwards.
 
 ```python
 from ogs5py import OGS
@@ -127,12 +112,58 @@ plt.plot(time, head)
 plt.show()
 ```
 
-Requirements
-------------
-The ogs5 executable needs to be in your sys-path. Otherwise you need to specify the path to the executable within the run command:
+<p align="center">
+<img src="https://raw.githubusercontent.com/GeoStat-Framework/ogs5py/master/docs/source/01_pump_test_drawdown.png" alt="Drawdown" width="600px"/>
+</p>
+
+
+### Reader
+
+It comes along with a set of handy readers for almost all output formats:
+
+* VTK Domain output
+
+        ogs5py.reader.readvtk
+
+* PVD Domain output
+
+        ogs5py.reader.readpvd
+
+* TECPLOT point output
+
+        ogs5py.reader.readtec_point
+
+* TECPLOT polyline output
+
+        ogs5py.reader.readtec_polyline
+
+
+### OGS5 executable
+
+The OGS5 executable needs to be in your sys-path under ``ogs``.
+Otherwise you need to specify the path to the executable within the run command:
 
     ogs.run_model(ogs_root="path/to/ogs")
 
-Created April 2018, Copyright Sebastian Mueller 2018
 
-(inspired by Falk Hesse and Miao Jing)
+## Requirements:
+
+- [NumPy >= 1.13.0](https://www.numpy.org)
+- [Pandas >= 0.23.0](https://pandas.pydata.org/)
+- [whichcraft](https://github.com/pydanny/whichcraft)
+- [meshio](https://github.com/nschloe/meshio)
+- [lxml](https://github.com/lxml/lxml)
+- [vtk](https://vtk.org/)
+- [pexpect](https://github.com/pexpect/pexpect)
+
+## Contact
+
+You can contact us via <[email protected]>.
+
+
+## License
+
+[GPL][gpl_link] © 2018-2019 (inspired by Falk Hesse and Miao Jing)
+
+[gpl_link]: https://github.com/GeoStat-Framework/ogs5py/blob/master/LICENSE
+[ogs5_link]: https://www.opengeosys.org/ogs-5/

README.md

@@ -3,8 +3,8 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = ogs5py
+SPHINXBUILD   = python3 -msphinx
+SPHINXPROJ    = GeoStatTools
 SOURCEDIR     = source
 BUILDDIR      = build
 

docs/Makefile

@@ -0,0 +1,8 @@
+#required for readthedocs.org
+numpy>=1.13
+pandas>=0.23.0
+whichcraft
+meshio
+lxml
+vtk
+pexpect

docs/requirements.txt

@@ -0,0 +1,20 @@
+{% extends "!layout.html" %}
+  {% block menu %}
+    <p class="link caption"><span class="link caption-text">Documentation</span></p>
+    {{ 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="">ogs5py Zenodo DOI</a>
+    <a href="">ogs5py PyPI</a>
+    <br />
+    <p class="link caption"><span class="link caption-text">GeoStat Framework</span></p>
+    <a href="https://geostat-framework.org">GeoStat Website</a>
+    <a href="https://github.com/GeoStat-Framework">GeoStat Github</a>
+    <a href="https://geostat-framework.readthedocs.io">GeoStat ReadTheDocs</a>
+    <a href="https://pypi.org/user/geostatframework/">GeoStat PyPI</a>
+    <br />
+    <br />
+    <a href="genindex.html">Index</a>
+    <a href="contents.html">Sitemap</a>
+  {% endblock %}