diff --git a/docs/releases/ogstools-0.2.0.md b/docs/releases/ogstools-0.2.0.md index 58573d51eca267070ccae3a52b5dbe2a04be56a3..0f752b0489e389d146dd58a3770ec2e42fe95532 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 2aa2bf86242d3a2d8a1b873686dfa0087220fd92..bebaa89bdb4046cefcd836404f4634c89c8a4e6d 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="", +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) ``` ______________________________________________________________________