/fmu-config

Tool for a general YAML to YAML/IPL setup in FMU runs. Replaces manual global_variables.ipl

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

fmu-config

fmu-config Python Version License: LGPL v3 Ruff PyPI

FMU config is a small Python library to facilitate configuration of global variables in Equinor's Fast Model Update (FMU) setup.

Installation

    pip install fmu-config

Usage

    fmuconfig global_config.yml

The idea is that there is one global config file that will be the "mother" of all other files, such as:

  • global_variables.ipl: IPL file to run from RMS
  • global_variables.ipl.tmpl: Templated IPL version where ERT will fill in <> variables
  • global_variables.yml: working YAML file, with numbers
  • global_variables.yml.tmpl: templated YAML file, with <...> instead of numbers; for ERT to process
  • Various eclipse file stubs (both "working" and template versions)
  • Working and templated files for other tools/scripts

The global_config file shall be in YAML format, with extension .yml

To run this package against the global configuration file, just run

Documentation

The documentation is location at https://equinor.github.io/fmu-config/

Contributing

See the Contributing document.

License

This software is released under LGPLv3.