All notable changes to ogs5py will be documented in this file.

1.2.2 - 2022-05-25


  • MSH.load now uses engine="python" as fallback in pandas to successfully read ogs meshes in some corner cases #16

  • removed redundant from io import open which were there for py2 compatibility #16

1.2.1 - 2022-05-15


  • MSH.import_mesh can handle meshio.Mesh as input now #13


  • pygmsh support was removed. You can’t use pygmsh Geometry objects to generate meshes anymore. Please generate beforehand and import the generated mesh. Other generators are using gmsh directly now. #13

1.2.0 - 2022-05-15


  • move to a pyproject.toml based installation: d5ea756

  • move from develop/master branches to a single main branch

  • use GitHub Actions for CI: b6811ce

  • use f-strings where possible #11

  • simplified documentation #11

  • added changelog to documentation #11

  • added citation file and paper reference #11

  • use Python 3 style classes #11


  • downlaod_ogs only supports version “5.7”, “5.7.1” and “5.8” since the CI for OGS5 was shut down: 8b1cc91


  • make downlaod_ogs work again 8b1cc91

  • documentation fix in GLI.add_polyline #7

  • require pygmsh<7 for now #11

1.1.1 - 2020-04-02


  • check if __version__ is present (only if installed)

1.1.0 - 2020-03-22


  • meshio 4 was not compatible

  • fixed integer type in exporting meshes with element/material IDs

  • better check for OGS5 success on Windows


  • drop py2.7 support

1.0.5 - 2019-11-18


  • MSH.set_material_id: better handling of non-int single values: f34d2e5

  • better handling of material IDs: 26b4610

  • GLI.add_polyline: Adding polyline by point-names was not possible: 17dd199


  • better integration of pygmsh: 570afd9

  • new functions specialrange and generate_time: e5f3aba

  • updated examples

1.0.4 - 2019-09-10


  • ogs5py was not usable offline: 0f98c32

  • add_exe was not recognizing operation system: 89b07e5


  • new sub-keywords for OUT (added to OGS5 in Aug 19) when using TECPLOT (TECPLOT_ELEMENT_OUTPUT_CELL_CENTERED, TECPLOT_ZONES_FOR_MG): ebcb22a


  • RFR Class was refactored to allow multiple variables: 3c1c445

1.0.3 - 2019-08-23


  • TempFile was not working on Windows: c0d0960

1.0.2 - 2019-08-22


  • Don’t fix QT_API for MAYAVI and use vtk for export: 33398ad

  • PopenSpawn has no close attribute on Windows: 12f05d6

1.0.1 - 2019-08-22


  • download_ogs(version="latest" build="PETSC") was not working: 552503b

1.0.0 - 2019-08-22


  • GLI.add_polyline now allows integer coordinates for points: bf5d684

  • MSH.centroids are now calculated as center of mass instead of center of element nodes: b0708a6

  • was not working: 6a0489b

  • OGS.run_model has now a better check for OGS success: 143d0ab

  • GMSH interface was updated to new meshio-API: d3e0594

  • RFR file was not written: 41e55f3

  • BC new sub-key TIME_INTERVAL was missing: 94ec5c5


  • download_ogs downloads a system dependent OGS5 executable: ede32e4

  • add_exe add a self compiled OGS5 executable: ede32e4

  • MSH.import_mesh now allows the import of material_id and element_id if given as cell_data in the external mesh: 00a77fa

  • 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: 00a77fa

  • New method MSH.set_material_id to set the material IDs for specific elements: 4b11c6a

  • now can show additional cell_data: ffd7604

  • New routine show_vtk to show vtk output with mayavi: f640c19

  • New method OGS.output_files to get a list of output files: 2f5f102

  • New attribute file_name for files: 632c2e7

  • BlockFile: new method append_to_block: efc9aac

  • OGS.gen_script now allowes multiple subkeys: 2cd344b


  • MSH.export_mesh argument add_data_by_id renamed to cell_data_by_id: 00a77fa

  • OGS.run_model argument ogs_root renamed to ogs_exe: 6fcdb61

  • Files that can occure multiple times (mpd, rfr, …) are better handled now: 4a9c9d2

  • ogs5py is now licensed under the MIT license: ae96c0e

  • Extra named files now get their name by keyword name: 632c2e7

0.6.5 - 2019-07-05


  • gli.add_polyline: Adding polyline by given point IDs was not possible: 3ec23af


  • New swap_axis routine in msh and gli: You can now easily swap axis of a mesh. If you have generated a 2D mesh in x-y you can get a x-z cross-section by swapping the y and z axis: 3ec23af

0.6.4 - 2019-05-16



  • New routine to zip data by IDs: 9accf6e

  • reading routines in the OGS Class: 592bc50

  • New del_block routine in Blockfiles: 8d15a90

0.6.3 - 2019-03-21


  • The used method os.makedirs has no keyword argument ‘exist_ok’ in python 2.7, so we prevent using it. See: 40fea36

0.6.2 - 2019-03-21


  • The vtk reading routine could not read multiple scalar cell data. See: 568e7be

0.6.1 - 2019-01-22


  • The BlockFile reading routine was cutting of the given keys. See: d82fd30

0.6.0 - 2019-01-22

First release of ogs5py.