There is a newer version of this record available.

Software Open Access

ogs5py v1.0.4

Sebastian Müller

Falk Heße


ogs5py is A python-API for the OpenGeoSys 5 scientific modeling package.


You can install the latest version with the following command:

pip install ogs5py

Documentation for ogs5py

You can find the documentation under

Further Information

Release Notes 1.0.x


  • TempFile was not working on Windows: c0d0960
  • Don't fix QT_API for MAYAVI and use vtk for export: 33398ad
  • PopenSpawn has no close attribute on Windows: 12f05d6
  • download_ogs(version="latest" build="PETSC") was not working: 552503b
  • 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
  • ogs5py was not usable offline: 0f98c32
  • add_exe was not recognizing operation system: 89b07e5


  • 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
  • new sub-keywords for OUT (added to OGS5 in Aug 19) when using TECPLOT (TECPLOT_ELEMENT_OUTPUT_CELL_CENTERED, TECPLOT_ZONES_FOR_MG): ebcb22a


  • 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
  • RFR Class was refactored to allow multiple variables: 3c1c445

Files (308.1 kB)
Name Size
308.1 kB Download
All versions This version
Views 42446
Downloads 797
Data volume 28.0 MB2.2 MB
Unique views 37243
Unique downloads 265


Cite as