iMODforge is a Windows installer of selected Deltares python packages and their dependencies. This makes the process of installing iMOD Python significantly easier.
You can download the signed installer here on oss.deltares.nl. After downloading, simply start the installer and follow the instructions.
You can start an environment with all correct paths via the iMODforge Prompt that can be found in your start menu.
From here you can start your editor so that the editor can find the installed components.
You can also directly call python to start an interactive python terminal.
Deltares packages currently included are:
Important non-Deltares packages included in iMODforge are:
Experience has shown that these packages can be difficult to install for new users, because it requires:
- Using a shell
- Knowledge of
conda/mamba/pixi/uv/pip. - Installing a lot of dependencies, where something breaks every now and then.
- Installing python packages without access to
conda-forgeorPyPiis cumbersome. Some computational servers have no direct internet connection.
The iMODforge installer aids new users by installing a conda base environment with all the required Python packages installed. These packages are contained in the executable. The installer thus helps circumventing the four issues mentioned above.
The tasks and dependencies for this package are handled via pixi.
The imodforge environment is only used for the pixi-pack command to create the packages that are to be installed.
The default environment is used to actually perform the tasks of creating an installer.
To build an installer from scratch, pixi pack needs to be run, and after that dotnet build.
This can be done in one go via pixi run create-imodforge.
Other useful commands for testing are pixi run build imodforge (not packing every time), pixi run test-install imodforge and pixi run test-uninstall imodforge (create log files in the repo directory).