OUTGRIF connects models

Download and Run

Software requirements

Python interpreter, version 3.8 or higher (see Python – Quick guide).
External libraries: NumPy, Pandas, PyYAML, matplotlib, and h5py.

Usage

OUTGRIF has no graphical user interface. All settings are provided in a single configuration file in YAML format.

To run the program, call it from the command line with the YAML file name as an argument. For example:

python OUTGRIF.py mesh.yaml

💡 On Windows, this can also be done by double-clicking the file start.bat located in the example folders in the ZIP package (see below).

The program does not overwrite existing files. If the target HDF5 or image file already exists, you must delete it or change its name in the YAML configuration.

License

This software is licensed under the GNU General Public License v3.0. You may use, modify, and share it freely. If you redistribute it with changes, you must also release the source code and maintain the same license.

ZIP file download

Program and examples

OUTGRIF.ZIP
├── Documentation/
│   ├── OUTGRIF_documentation.url
├── Examples/
│   ├── MSH/
│   │   ├── mesh.msh
│   │   ├── mesh.yaml
│   │   ├── start.bat
│   │   ├── output/
│   │   │   ├── grid_A.h5
│   │   │   ├── grid_A_XZ_plane_X0.csv
│   │   │   ├── grid_A_YZ_plane_X0.png
│   ├── S3D/
│   │   ├── gwv.s3d
│   │   ├── gwv.yaml
│   │   ├── start.bat
│   │   ├── output/
│   │   │   ├── out.csv
│   │   │   ├── out.h5
│   │   │   ├── out.png
├── Sources/
│   ├── grid_data.py
│   ├── grid_data_mesh.py
│   ├── grid_data_modflow.py
│   ├── info.py
│   ├── mesh.py
│   ├── mesh_band_model.py
│   ├── modflow.py
│   ├── outgrid_base.py
│   ├── outgrid_data.py
│   ├── outgrid_performing.py
│   ├── OUTGRIF.py

Structure of the ZIP archive