fmu-settings
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-settingsis the core library for reading, writing, and managing.fmu/resources.fmu-datamodelsprovides shared Pydantic domain models.fmu-settings-apiexposesfmu-settingsthrough a FastAPI application layer and serves the packaged GUI assets.fmu-settings-guiprovides the browser-based user interface and packages its static assets.fmu-settings-cliprovides 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.
3 maintainers
Release files for fmu-settings 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fmu_settings-1.3.0.tar.gz | 822.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fmu_settings-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 897.4 kB
Release files / fmu_settings-1.3.0.tar.gz
| Download URL | fmu_settings-1.3.0.tar.gz |
|---|---|
| Size | 822.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
34b1a53dd08790a1d0babaa7c5dc08b9e5120a18febb2ed3db43a8cdc6aec556
|
|
BLAKE2b-256 checksum How to use checksums |
cf002121dc489918892b66b6f4a0602e243ff1152ef25511fc3cdf3a6fb70aa5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.
Transparency logRelease files / fmu_settings-1.3.0-py3-none-any.whl
| Download URL | fmu_settings-1.3.0-py3-none-any.whl |
|---|---|
| Size | 75.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9d4e78feb9f8261394e359127b81db3c55f950ebce9eb6da82e723437446550e
|
|
BLAKE2b-256 checksum How to use checksums |
48335ff5e1e52f19551a68224ce5dea8c8c7927bcd2acde683a08e8e9b0c95d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.
Transparency log
