joergbuchwald / joss_ogs6py_vtuinterface Goto Github PK
View Code? Open in Web Editor NEWLicense: BSD 3-Clause "New" or "Revised" License
License: BSD 3-Clause "New" or "Revised" License
I also have some suggestions for paper.md
to improved readability (my final issue I promise 😄)
Summary
-The usage of the modules is demonstrated with common workflow operations, including parameter variations, boundary
-conditions, solver settings, verification of simulation results by comparison to analytical solutions, set-up and evaluation of
-ensemble runs, convenient analysis of results by line plots, time series, or transient contour plots.
+The use of the modules is demonstrated with common workflow operations, including parameter variations, setting
+boundary conditions, changing solver settings, verification of simulation results by comparison to analytical solutions,
+set-up and evaluation of ensemble runs, and convenient analysis of results by line plots, time series, or transient contour
+plots.
Statement of need
-The attractiveness of Python is not limited to post-processing; pre-processing tasks can simply be conducted, using
-packages as the Python wrapper for GMSH [@geuzaine2009gmsh] and the tool meshio [@nico_schlomer_2021_4745399].
-While many existing open-source tools force the user to learn a new syntax for interacting with the software, Python
-bindings allow control in a general language and thus more accessible for a wider community of users.
+The attractiveness of Python is not limited to post-processing; pre-processing tasks can be simply conducted,
+using packages such as the Python wrapper for GMSH [@geuzaine2009gmsh] or the tool meshio
+[@nico_schlomer_2021_4745399]. While many existing open-source tools force the user to learn a new syntax for
+interacting with the software, Python bindings allow control in a general language and thus are more accessible for a wider
+community of users.
-The mentioned Python packages focus on visualization aspects, and except for Paraview, to our knowledge, the mentione
-packages do not have file support for PVD files or time-series data[@pvdissue; @timeseriesissue].
+The mentioned Python packages focus on visualization aspects, and except for Paraview, to our knowledge, do not have file
+support for PVD files or time-series data[@pvdissue; @timeseriesissue].
Features
-model = OGS(INPUT_FILE="tunnel_ogs6py.prj", PROJECT_FILE="tunnel_exc.prj")
+model = OGS(INPUT_FILE="tunnel.prj", PROJECT_FILE="tunnel_exc.prj")
-One of the most significant features of VTUinterface is the ability to deal with PVD files as time-series data.
-E.g., the following command reads in the VTU point field “pressure” at point “pt0,” defined in a dictionary, using nearest
-neighbour interpolation.
+One of the most powerful features of VTUinterface is the ability to deal with PVD files as time-series data.
+For example, the following command reads in the VTU point field “pressure” at point “pt0,” defined in a dictionary, using nearest
+neighbour interpolation.
Technical details
-ogs6py requires python 3.9 and uses lxml to process OGS6 input files and uses the subprocess module to run OGS.
+ogs6py requires python 3.8 or above and uses lxml to process OGS6 input files and uses the subprocess module to run OGS.
-VTUinterface requires python 3.8 ...
+VTUinterface requires python 3.8 or above ...
Applications
-Both introduced packages are relatively new, being only 1 to 2 years old.
+Both of the packages introduced are relatively new, being only 1 to 2 years old.
-E.g., a YouTube video was published explaining their use;
+For example, a YouTube video was published explaining their use;
Note I think I tested ogs6py
in python 3.8, so I think it works with that (at least, that is what you changed the min version to in #4. So I suggested that change in the paper above.
Congratulations again on developing these tools. I think that lots of OGS users will find them very helpful.
The line where the OGS project file is opened in the demo notebook
model = OGS(INPUT_FILE="tunnel_ogs6py.prj", PROJECT_FILE="tunnel_exc.prj", MKL=True)
refers to a INPUT_FILE
that doesn't exist in the repository. I think it should just be INPUT_FILE="tunnel.prj"
.
Interestingly, that cell executes without error, even though the input file doesn't exist. It is only when executing the following cell in the notebook
model.replace_text("tunnel_exc", xpath="./time_loop/output/prefix")
that an error is thrown
(lots of stack traces here)
OSError: Error reading file 'tunnel_ogs6py.prj': failed to load external entity "tunnel_ogs6py.prj"
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.