update changelog and readme [skip-ci]

CHANGELOG.md

@@ -14,14 +14,22 @@ All notable changes to **ogs5py** will be documented in this file.
 
 ### Additions
 * ``download_ogs`` downloads a system dependent OGS5 executable: https://github.com/GeoStat-Framework/ogs5py/commit/ede32e411785b51cdd0983a924c3c7ea117ab026
+* ``add_exe`` add a self compiled OGS5 executable: https://github.com/GeoStat-Framework/ogs5py/commit/ede32e411785b51cdd0983a924c3c7ea117ab026
 * ``MSH.import_mesh`` now allows the import of material_id and element_id if given as cell_data in the external mesh: https://github.com/GeoStat-Framework/ogs5py/commit/00a77fae9d492eb16872443e9be4262d4515da27
 * ``MSH.export_mesh`` now automatically exports material_id (already the case before) and element_id.
   Also you can now export additional ``point_data`` and ``field_data``: https://github.com/GeoStat-Framework/ogs5py/commit/00a77fae9d492eb16872443e9be4262d4515da27
 * New method ``MSH.set_material_id`` to set the material IDs for specific elements: https://github.com/GeoStat-Framework/ogs5py/commit/4b11c6a70164565a8ab0b58d56b084b27ea781f1
+* ``MSH.show`` now can show additional cell_data: https://github.com/GeoStat-Framework/ogs5py/commit/ffd76045e0591a00fd51c937ba62c4d5945c3fed
+* New routine ``show_vtk`` to show vtk output with mayavi: https://github.com/GeoStat-Framework/ogs5py/commit/f640c1977d7b9a869c56f61186613c8b9c9ef345
+* New method ``OGS.output_files`` to get a list of output files: https://github.com/GeoStat-Framework/ogs5py/commit/2f5f10237c1b54d21b0b6a01598680e889dc7bf6
+* New attribute ``file_name`` for files: https://github.com/GeoStat-Framework/ogs5py/commit/632c2e7b1ab33ec3b55bd8be6fbbe1f67d5c5651#diff-bc322c8565356d4543aca0a3d0e0a578
 
 ### Changes
 * ``MSH.export_mesh`` argument ``add_data_by_id`` renamed to ``cell_data_by_id``: https://github.com/GeoStat-Framework/ogs5py/commit/00a77fae9d492eb16872443e9be4262d4515da27
-* ``ogs5py`` is now licensed under the MIT license
+* ``OGS.run_model`` argument ``ogs_root`` renamed to ``ogs_exe``: https://github.com/GeoStat-Framework/ogs5py/commit/6fcdb617b4f61e738240830d637a0718732a66ad
+* Files that can occure multiple times (mpd, rfr, ...) are better handled now: https://github.com/GeoStat-Framework/ogs5py/commit/4a9c9d2a2209e49b336bdb59fd51f3362be44c8f
+* ``ogs5py`` is now licensed under the MIT license: https://github.com/GeoStat-Framework/ogs5py/commit/ae96c0e7a5889632e9c34d0fc4577df587da3164
+* Extra named files now get their name by keyword ``name``: https://github.com/GeoStat-Framework/ogs5py/commit/632c2e7b1ab33ec3b55bd8be6fbbe1f67d5c5651#diff-bc322c8565356d4543aca0a3d0e0a578
 
 ## [0.6.5] - 2019-07-05
 

README.md

@@ -54,7 +54,6 @@ model.msh.generate("radial", dim=2, rad=range(51))
 model.gli.generate("radial", dim=2, rad_out=50.)
 model.gli.add_points([0., 0., 0.], "pwell")
 model.gli.add_points([1., 0., 0.], "owell")
-
 model.bc.add_block(  # boundary condition
     PCS_TYPE='GROUNDWATER_FLOW',
     PRIMARY_VARIABLE='HEAD',
@@ -77,7 +76,6 @@ model.mmp.add_block(  # medium properties
     GEOMETRY_DIMENSION=2,
     STORAGE=[1, 1.0e-04],
     PERMEABILITY_TENSOR=['ISOTROPIC', 1.0e-4],
-    POROSITY=0.2,
 )
 model.num.add_block(  # numerical solver
     PCS_TYPE='GROUNDWATER_FLOW',
@@ -91,17 +89,13 @@ model.out.add_block(  # point observation
     TIM_TYPE=['STEPS', 1],
 )
 model.pcs.add_block(  # set the process type
-    PCS_TYPE='GROUNDWATER_FLOW',
-    NUM_TYPE='NEW',
+    PCS_TYPE='GROUNDWATER_FLOW', NUM_TYPE='NEW'
 )
 model.tim.add_block(  # set the timesteps
     PCS_TYPE='GROUNDWATER_FLOW',
     TIME_START=0,
     TIME_END=600,
-    TIME_STEPS=[
-        [10, 30],
-        [5, 60],
-    ],
+    TIME_STEPS=[[10, 30], [5, 60]],
 )
 model.write_input()
 success = model.run_model()
@@ -119,42 +113,37 @@ plt.show()
 </p>
 
 
-### Reader
-
-It comes along with a set of handy readers for almost all output formats:
-
-* VTK Domain output
-
-    ```python
-    from ogs5py.reader import readvtk
-    ```
-
-* PVD Domain output
-
-    ```python
-    from ogs5py.reader import readpvd
-    ```
+### OGS5 executable
 
-* TECPLOT point output
+To obtain an OGS5 executable, ``ogs5py`` brings a download routine:
 
-    ```python
-    from ogs5py.reader import readtec_point
-    ```
+```python
+from ogs5py import download_ogs
+download_ogs()
+```
 
-* TECPLOT polyline output
+Then a executable is stored in the ogs5py config path and will be called
+when a model is run.
 
-    ```python
-    from ogs5py.reader import readtec_polyline
-    ```
+You can pass a ``version`` statement to the ``download_ogs`` routine, to
+obtain a specific version (5.7, 5.7.1 (win only) and 5.8).
+Also "latest" and "stable" are possible.
+For OGS 5.7 there are executables for Windows/Linux and MacOS.
+For "5.8", "latest" and "stable" there are no MacOS pre-builds.
+Have a look at the documentation for all options.
 
+If you have compiled your own OGS5 version, you can add your executable
+to the ogs5py config path with:
 
-### OGS5 executable
+```python
+from ogs5py import add_exe
+add_exe("path/to/your/ogs/exe")
+```
 
-The OGS5 executable needs to be in your sys-path under ``ogs[.exe]``.
 Otherwise you need to specify the path to the executable within the run command:
 
 ```python
-model.run_model(ogs_root="path/to/ogs")
+model.run_model(ogs_exe="path/to/ogs")
 ```