Skip to content

Utility functions for data transfer of FMU data with rich metadata, for REP, SUMO, etc

License

Notifications You must be signed in to change notification settings

mferrera/fmu-dataio

 
 

Repository files navigation

fmu-dataio

linting Code style: black PyPI version PyPI - Python Version PyPI - License ReadTheDocs

fmu-dataio is a library for handling data flow in and out of Fast Model Update workflows. For export, it automates the adherence to the FMU data standard ✅ including both file and folder conventions as well as richer metadata 🔖 for use by various data consumers both inside and outside the FMU context via Sumo.

fmu-dataio is designed to be used with the same syntax in all parts of an FMU workflow, including post- and pre-processing jobs and as part of ERT FORWARD_MODEL, both inside and outside RMS.

👉 Detailed documentation for fmu-dataio at Read the Docs. 👀

fmu-dataio is also showcased in Drogon. 💪

Data standard definitions

Radix

The metadata standard is defined by a JSON schema. Within Equinor, the schema is available on a Radix-hosted endpoint ⚡

Installation

Install a specific version (e.g. 1.2.3) directly from github through:

pip install git+ssh://git@github.com/equinor/fmu-dataio@1.2.3

Local development and testing:

Make your own fork of fmu-dataio and then clone it locally on unix. Create a virtual environment:

python -m venv my_venv

Activate the venv:

source my_venv/bin/activate

Upgrade pip and install fmu-dataio from the source:

pip install --upgrade pip
pip install -e .

Install requirements for running tests:

pip install -e .[tests,docs]

Then run the command:

pytest

About

Utility functions for data transfer of FMU data with rich metadata, for REP, SUMO, etc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.5%
  • Other 0.5%