fmu-pem 1.0.0

📚 User documentation

What is fmu-pem?

Petro-elastic model (PEM) for use in e.g. fmu-sim2seis based on the rock-physics-open library.

How to use fmu-pem?

Installation

To install fmu-pem, first activate a virtual environment, then type:

pip install fmu-pem

The PEM is controlled by parameter settings in a yaml-file, given as part of the command line arguments, or by the workflow parameter if it is run as an ERT forward model.

Calibration of rock physics models

Calibration of the rock physics models is normally carried out in RokDoc prior to running the PEM. Fluid and mineral properties can be found in the RokDoc project, or from LFP logs, if they are available.

[!NOTE] The fluid models contained in this module may not cover all possible cases. Gas condensate, very heavy oil, or reservoir pressure under hydrocarbon bubble point will need additional proprietary code to run.

Equinor users can install additional proprietary models using

pip install "git+https://github.com/equinor/rock-physics@v2.0.0"`

How to develop fmu-pem?

Developing the user interface can be done by:

cd ./documentation
npm ci  # Install dependencies
npm run create-json-schema  # Extract JSON schema from Python code
npm run docs:dev  # Start local development server

The JSON schema itself (type, title, description etc.) comes from the corresponding Pydantic models in the Python code.