deltares / imod-documentation Goto Github PK
View Code? Open in Web Editor NEW๐ Documentation of the iMOD suite.
Home Page: https://deltares.github.io/iMOD-Documentation/
๐ Documentation of the iMOD suite.
Home Page: https://deltares.github.io/iMOD-Documentation/
We should move the docs at https://deltares.github.io/imod_coupler/ to https://deltares.github.io/iMOD-Documentation/coupler_index.html
I was asked by @Hofer-Julian to review the iMOD documentation and there are a couple of points that I would like to address:
https://deltares.github.io/iMOD-Documentation/introduction.html#tbl-iMOD-comparison
The comparison table uses the terms iMOD GUI and MODFLOW 2005, iMOD 3D Viewer. To me it is unclear if the iMOD GUI and the iMOD 3D Viewer are the same. And I also understand that it should be iMODFLOW and not MODFLOW 2005, since it is a heavily modified fork of MODFLOW 2005.
https://deltares.github.io/iMOD-Documentation/viewer_install.html#sec-install_QGIS
Link is not formatted correctly. Probably a simple whitespace issue.
At the default installation of mamba, mamba is not added to the PATH. mamba is then not recongnized
People who want to transition to the iMOD Suite might have an existing Modflow 2005 model, the 'vanilla' USGS version, that is.
This model can be read using Flopy and consequently be written to a iMODFLOW or Modflow6 model using iMOD Python.
An example of this in either the iMOD Suite documentation or the iMOD Python documentation, would be very useful.
This might be something for the iMOD Python documentation.
A few years ago, @Huite and @jc-hunink created a FAQ section in the iMOD Python documentation.
We should evaluate if this is still up to date or should be extended (probably the latter).
Places to collect questions:
The current MetaMod coupler documentation section mentions:
I think it makes a lot of sense to have another section called "preprocessing". This is obviously relevant to most users, as they will be quite involved with the spatial coupling logic (making sure models align for example).
Such a document should introduce the primod
package, explain the requirements before a model can be coupled in terms of its schematization and concepts, mention how the automatic definition is exchanges is done (based on spatial locations), as well as mention the relevant components of all models. A full example is not required, but for readability, some duplication might be desirable.
From Frans:
Ter info: op de pagina https://deltares.github.io/iMOD-Documentation/index.html staat een link naar de iMOD 5 informatie.
Die link is https://oss.deltares.nl/nl/web/imod maar werkt niet. Dat komt omdat er een โ/nl/โ te veel staat.
Also:
The references to imod.xyz should be changed to:
https://gitlab.com/deltares/imod/imod-python/pages
Description of minimal qgis requirements is not clear.
See also issue on imod-qgis
https://github.com/Deltares/imod-qgis/issues/24
Not all ipf formats are supported in iMOD Suite tools. Add the supported ipf formats as known issue to the documentation.
As @Huite correctly pointed out, the architecture of imod coupler is currently under-documented.
Especially the following:
All things need to be synchronized to get all pipelines running properly. In which order should you push the changes?
In GitLab by @tvw11 on Nov 1, 2023, 10:44
By providing a few necessary paths to the modflow and metaswap libraries for iMOD Coupler, we can write the coupled models. You can download the modflow and metaswap libraries as part of the the last iMOD5 release <https://oss.deltares.nl/web/imod/download-imod5>
_
mf6_dll = "./path/to/mf6.dll"
metaswap_dll = "./path/to/metaswap.dll"
metaswap_dll_dependency = "./path/to/metaswap/dll/dependency"
Downloading via the link went fine, but afterwards it is unclear which paths should be inserted here, especially the metaswap_dll_dependency, which should be the dir (probably renaming to metaswap_coupler_dir could already make it more clear).
Quite commonly errors are thrown because long paths not enabled. This is especially common on Windows computational servers, which consist of virtual machines which have long paths disabled (usually this is standard, unfortunately). What makes this more annoying, is that the virtual machines not always print the actual paths (which are long, containing all kinds of hashes and words like "SNAPVOLUMES"), so little clues are left to the source of problems.
For example, I just had a colleague where Deltaforge threw a vague "Extraction failed" error (Miniconda installer as well), and the issue in the end was resolved by enabling long paths.
Relevant tip how to fix (can probably link):
https://www.howtogeek.com/266621/how-to-make-windows-10-accept-file-paths-over-260-characters/
For the last Delft Software Days, we've made course material in the form of a jupyter notebook.
So far, we have not added that to the iMOD Documentation.
Quarto supports including Jupyter notebooks, so it shouldn't be too much work to add this.
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.