fmu-settings

ci docs

Documentation: https://equinor.github.io/fmu-settings/

Source code: https://github.com/equinor/fmu-settings/

fmu-settings is the Python core library for reading, writing, and managing resources in .fmu/ directories for FMU projects and user environments.

It owns the filesystem behavior around those resources: initialization, discovery, configuration models, resource managers, locking, cache handling, changelogs, restore behavior, and synchronization helpers.

FMU Settings Architecture

FMU Settings is split across a few repositories:

flowchart LR
    CLI["fmu-settings-cli"]
    API["fmu-settings-api\nAPI and static-file host"]
    GUI["fmu-settings-gui\nReact source and packaged assets"]
    LIB["fmu-settings"]
    MODELS["fmu-datamodels"]

    CLI -->|starts one application process| API
    CLI -->|gets packaged assets| GUI
    CLI --> LIB
    GUI -->|browser API calls| API
    API --> LIB
    LIB --> MODELS
    API --> MODELS
  • fmu-settings is the core library for reading, writing, and managing .fmu/ resources.
  • fmu-datamodels provides shared Pydantic domain models.
  • fmu-settings-api exposes fmu-settings through a FastAPI application layer and serves the packaged GUI assets.
  • fmu-settings-gui provides the browser-based user interface and packages its static assets.
  • fmu-settings-cli provides the user-facing command line interface, including commands that bootstrap local user state and launch the combined application.

See ARCHITECTURE.md for the library architecture and a high-level ecosystem overview.

Documentation

The published documentation is the best starting point for users:

Documentation sources live under docs/src/.

Developing

Clone and install into a virtual environment.

git clone git@github.com:equinor/fmu-settings.git
cd fmu-settings
# Create or source virtual/Komodo env
pip install -U pip
pip install -e ".[dev]"
# Make a feature branch for your changes
git checkout -b some-feature-branch

Run the tests with:

pytest -n auto tests

Ensure your changes will pass the various linters before making a pull request. It is expected that all code will be typed and validated with mypy.

ruff check
ruff format --check
mypy src tests

If you need to change the schema of ProjectConfig, UserConfig, or InternalMappings, see the schema migration guide for implementation and testing details.

See CONTRIBUTING.md for more.

[!NOTE]

Trademark Notice and Disclaimer

Aspen RMS™ is a registered trademark of Aspen Technology, Inc. (AspenTech). Use of RMS™ is governed by AspenTech's licensing terms and conditions. It is proprietary software and is neither open-source nor free. A valid license agreement with AspenTech is required for its use.

fmu-settings is an independent project developed by Equinor and is neither produced by nor affiliated with AspenTech.

Project links

Data verified by PyPI on Aug 26, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for GibranAlfa from gravatar.com GibranAlfa Avatar for slang from gravatar.com slang Avatar for tnatteroy from gravatar.com tnatteroy

Credits

Author: Equinor

GitHub Statistics

Data verified by PyPI on Aug 26, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

GPL-3.0

Requires

Python >=3.11

Provides Extra

dev docs

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fmu_settings-1.2.0.tar.gz (803.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fmu_settings-1.2.0-py3-none-any.whl (74.6 kB view details)

Uploaded Python 3

File details

Details for the file fmu_settings-1.2.0.tar.gz.

File metadata

  • Download URL: fmu_settings-1.2.0.tar.gz
  • Upload date:
  • Size: 803.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for fmu_settings-1.2.0.tar.gz
Algorithm Hash digest
SHA256 1ed93e918256f13bba9306d15c10c7bd6f1b23b339ae422e462cb8a64b5542c5
MD5 081e5d7ff2f9d5589c635a9fbedf9deb
BLAKE2b-256 f1d5349a851ed3539167258591802c124d5ed9086984af14052365083dc582e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for fmu_settings-1.2.0.tar.gz:

Publisher: publish.yml on equinor/fmu-settings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fmu_settings-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: fmu_settings-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 74.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for fmu_settings-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b708005fc465d35a54cc5f46636617f75cf105e183e692bff71df2580b28c6a
MD5 61eb988acb2ede99626ddebcffa8f574
BLAKE2b-256 a88c30828ef3fbc1e9b2e06f20e359e710bf303b6dd5805f7633e2e6f41659fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for fmu_settings-1.2.0-py3-none-any.whl:

Publisher: publish.yml on equinor/fmu-settings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 files

1.1.0

2 files

1.0.0

2 files

0.34.0

2 files

0.33.0

2 files

0.32.1

2 files

0.32.0

2 files

0.31.0

2 files

0.30.0

2 files

0.29.1

2 files

0.29.0

2 files

0.28.1

2 files

0.28.0

2 files

0.27.0

2 files

0.26.0

2 files

0.25.0

2 files

0.24.0

2 files

0.23.2

2 files

0.23.1

2 files

0.23.0

2 files

0.22.0

2 files

0.21.0

2 files

0.20.0

2 files

0.19.0

2 files

0.18.1

2 files

0.18.0

2 files

0.17.0

2 files

0.16.1

2 files

0.16.0

2 files

0.15.0

2 files

0.14.1

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page