GeoStat-Framework/ogs5py v1.0.0

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 ogs5py

Documentation for ogs5py

You can find the documentation under geostat-framework.readthedocs.io.

Further Information

• General homepage: https://www.opengeosys.org/ogs-5
• OGS5 Repository: https://github.com/ufz/ogs5
• Keyword documentation: https://ogs5-keywords.netlify.com
• OGS5 Benchmarks: https://github.com/ufz/ogs5-benchmarks
• ogs5py Benchmarks: https://github.com/GeoStat-Framework/ogs5py_benchmarks

Release Notes

Bugfixes

• 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
• MSH.show 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

Additions

• 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
• MSH.show 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

Changes

• 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