Merge branch 'update_release_notes' into 'main'

Update_Release_notes See merge request ogs/tools/ogstools!98
ufz · Dec 4, 2023 · 825bbc0 · 825bbc0
2 parents 2378eba + 0d43559
commit 825bbc0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 12 deletions.
diff --git a/docs/releases/ogstools-0.2.0.md b/docs/releases/ogstools-0.2.0.md
@@ -3,8 +3,9 @@
 ## Library
 
 [`studies`](../user-guide/studies.md) a new package that provides utility functions to compose studies from multiple simulation
-runs.
-Now it contains functions to perform convergence studies.
+runs. For now it contains functions to perform convergence studies on simulation results (with increasing spatial/temporal discretization) for specific timesteps or over all timesteps.
+
+[`msh2vtu`](../user-guide/msh2vtu.md) got a cleaner python interface without the need to run argparse in between.
 
 [`feflowlib`](../user-guide/feflowlib.md) has been updated with new functionalities.
 In particular, material properties can now be taken into account when converting and creating OGS models.

diff --git a/docs/user-guide/msh2vtu.md b/docs/user-guide/msh2vtu.md
@@ -31,24 +31,20 @@ prog: msh2vtu
 In addition, it may be used as Python module:
 
 ```python
-from ogstools.msh2vtu import run  # to run mesh conversion
-import argparse
+from ogstools.msh2vtu import msh2vtu
 
-parser = argparse.ArgumentParser()
-
-# generate a mesh, e.g. my_mesh.msh with Gmsh
-
-args = argparse.Namespace(
-    filename="my_mesh.msh",
-    output="",
+msh2vtu(
+    input_filename="my_mesh.msh",
+    output_path="",
+    output_prefix="my_meshname",
     dim=0,
     delz=False,
     swapxy=False,
     rdcd=True,
     ogs=True,
     ascii=False,
+    log_level="DEBUG",
 )
-run(args)
 ```
 
 ______________________________________________________________________