From 4ea97bdc043238e33976e25aa84782d2bc7529c2 Mon Sep 17 00:00:00 2001
From: Florian Zill <florian.zill@ufz.de>
Date: Mon, 4 Dec 2023 14:12:46 +0100
Subject: [PATCH] Update 2 files
- /docs/releases/ogstools-0.2.0.md
- /docs/user-guide/msh2vtu.md
---
docs/releases/ogstools-0.2.0.md | 5 +++--
docs/user-guide/msh2vtu.md | 16 ++++++----------
2 files changed, 9 insertions(+), 12 deletions(-)
diff --git a/docs/releases/ogstools-0.2.0.md b/docs/releases/ogstools-0.2.0.md
index 58573d51e..0f752b048 100644
--- 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
index 2aa2bf862..73680c0ff 100644
--- 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="",
+def 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)
```
______________________________________________________________________
--
GitLab