Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/src/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,15 @@ fmu init

You have now initialized FMU Settings.

>##### Important:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced with build-in notification

>**For early onboarders to SUMO**, that already have masterdata in the global config before initialization of FMU Settings:
>
>The initialization triggers FMU Settings to look for an existing global config file at the standard location: `fmuconfig/output/global_variables.yml`. If a valid configuration is found here, FMU Settings will import the sections `masterdata`, `model` and `access`, so that you will not have to configure everything again.
>
>**NB! Stratigraphy is not imported**. Stratigraphy data must be configured directly in the GUI. When configuration of the stratigraphy is completed in the FMU Settings GUI, these sections should be deleted from the global config yaml file.

```{important}
**For early onboarders to Sumo**, that already have masterdata in the global config before initialization of FMU Settings:

The initialization triggers FMU Settings to look for an existing global config file at the standard location: `fmuconfig/output/global_variables.yml`. If a valid configuration is found here, FMU Settings will import the sections `masterdata`, `model` and `access`, so that you will not have to configure everything again.

**NB! Stratigraphy is not imported**. Stratigraphy data must be configured directly in the GUI. When configuration of the stratigraphy is completed in the FMU Settings GUI, these sections should be deleted from the global config yaml file.
```


3. Open FMU Settings:
```bash
Expand Down Expand Up @@ -74,6 +77,8 @@ cd project/asset/resmod/ff/25.0.0
fmu settings
```

NB: FMU Settings can be opened from anywhere in your project folder hierarchy by running the command `fmu settings`. FMU Settings will in that case automatically detect the nearest project. Inside the FMU Settings GUI you will be able to open a project either from the list of **recent projects** or by entering the project path manually.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to native tip box

```{tip}
FMU Settings can be opened from anywhere in your project folder hierarchy by running the command `fmu settings`. FMU Settings will in that case automatically detect the nearest project. Inside the FMU Settings GUI you will be able to open a project either from the list of **recent projects** or by entering the project path manually.

Once the FMU Settings project is open, continue with the [GUI user guide](gui_user_guide.md).
```
21 changes: 11 additions & 10 deletions docs/src/gui_user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,13 @@ The page itself includes instructions for how to get the SMDA subscription key,

After you save the key, it is hidden in the application.

```{note}
[SMDA](https://smda.equinor.com) is the database containing the master data.
```

## Step 3: Set up masterdata

The **Masterdata** page shows the masterdata saved in the project, including:
The **Masterdata** page shows the masterdata references saved in the project, including:

- field
- country
Expand Down Expand Up @@ -172,23 +176,20 @@ You can click horizons and zones to add or remove them. There are also **Add all

If the project contains horizons or zones that no longer exist in RMS, FMU Settings asks you to remove them before saving.

## Step 5: Map RMS stratigraphy to SMDA
## Step 5: Map RMS stratigraphy to the SMDA stratigraphic column

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what is the most correct, but I would write this as

Suggested change
## Step 5: Map RMS stratigraphy to the SMDA stratigraphic column
## Step 5: Map RMS stratigraphy to the stratigraphic column in SMDA

I see we sometimes write it like this, but most places we say SMDA stratigraphic column. We should try to be consistent here.


The **Stratigraphy** page allows you to map your RMS names and aliases to the SMDA names.
The **Stratigraphy** page allows you to map your RMS names and aliases to the names in the SMDA stratigraphic columns.

The stratigraphy you configured in **Step 4** will be displayed here, with your RMS elements marked as "RMS". Each stratigraphic element (zones and horizons) will have a corresponding SMDA field.

#### How to map RMS to SMDA name:
#### How to map RMS to the SMDA stratigraphic column:
1. Click the Edit icon (pen symbol) for the zone or horizon you want to edit.
2. A window will pop up with a drop-down menu listing available SMDA stratigraphic elements.
3. Select the corresponding SMDA horizon or zone from the list.
2. A window will pop up with a drop-down menu listing stratigraphy definitions from the stratigraphic column in SMDA.
3. Select the corresponding horizon or zone from the list.
4. If needed, add one or more aliases for the RMS name.
5. Save your changes.

If an RMS zone or horizon does not exist in SMDA, select “Zone does not exist in SMDA”.

#### Upcoming feature: Automatic mapping

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this as it felt a bit misplaced in the documentation (?)

An upcoming feature for FMU Settings is an automatic mapping functionality. This will attempt to auto-match RMS names to SMDA names. You will then only need to verify the results and manually map any horizons or zones that could not be automatically matched.
If an RMS zone or horizon is not defined in the SMDA stratigraphic column, select “Zone doesn't exist in SMDA” or "Horizon doesn't exist in SMDA".


## Optional: Review earlier saved versions
Expand Down
15 changes: 5 additions & 10 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# FMU Settings documentation

**FMU Settings** is a tool that will simplify the handling of FMU model metadata, meaning metadata related to the FMU model itself and metadata needed when you are exporting data objects from FMU models.
**FMU Settings** is a tool that will simplify the handling of FMU model metadata (metadata related to the FMU model itself) and references to master data (required for making FMU results usable in other applications and contexts).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is a bit heavy, maybe we can try to shorten it a bit.. do we need the first parentheses here?

Suggested change
**FMU Settings** is a tool that will simplify the handling of FMU model metadata (metadata related to the FMU model itself) and references to master data (required for making FMU results usable in other applications and contexts).
**FMU Settings** is a tool that simplifies the handling of FMU model metadata and references to master data (required for making FMU results usable in other applications and contexts).


FMU Settings lets you manage static configuration through a graphical user interface (GUI) instead of editing files manually. In FMU Settings GUI, you can:
- Set up FMU project metadata
- Link FMU models to SMDA and other official metadata sources, including
- mapping of RMS stratigraphy to the SMDA stratigraphic column
- *mapping of wells between RMS, Eclipse and SMDA (future feature, currently not implemented)*
- Add master data references in FMU models, including
- referencing stratigraphic units in e.g. RMS to the stratigraphic column in SMDA
- *mapping of wells between different FMU components and to the official definitions (SMDA) (future feature, currently not implemented)*
- keeping track of version history for your FMU project settings


### If you are new to FMU Settings
1. Read the [Overview](overview.md) page to learn what FMU Settings is and how it is used.
2. Follow instructions on the [Getting started](getting_started.md) page to get started with FMU Settings for your FMU model(s).
Expand All @@ -20,12 +21,6 @@ If you find bugs, need help or have questions or if you have suggestions for new
- <a href="https://equinor.enterprise.slack.com/archives/C09MFKN4NC9" target="_blank" rel="noopener noreferrer">#fmu-settings slack channel</a>
- <a href="https://fmu.equinor.com" target="_blank" rel="noopener noreferrer">FMU portal</a>

### Upcoming features

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this as it felt a bit misplaced in the documentation (?)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not so sure about this. The intention is to make users aware of upcoming features in FMU Settings when they first started using the app. Some of the user feedbacks are asking about new features like mapping to other FMU components. With this section the users are aware that we are working on that. It's debatable to put this in the documentation, but maybe this is the easiest place to put.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question is, I guess, if documentation should include only what is, not what will be. There is also a risk that the documentation makes promises to users that we won't keep, if other things are prioritized etc. Anyways, this is not particularly critical - I can put it back in 👍

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's fair point, documentation should only include the current state. I'm fine with removing this from docs if others agreed.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is ok to remove it. If we see that many users are coming to us with suggestions for new features or asking what will be added next we can consider to add it back in. For now I think it is better to remove it to avoid user expectation for new features, which, as Per Olav says, we sometimes can't keep


FMU Settings is still being developed and some of the coming features will be:
- mapping of well names between RMS, Eclipse/Flow (or other simulators) and SMDA (or other sources)
- handling of and synchronization between user copies and the master project


```{toctree}
:maxdepth: 2
Expand Down
20 changes: 14 additions & 6 deletions docs/src/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ FMU Settings is a web application (localhost) that provides a user-friendly solu

## Why FMU Settings?

Today, configuring your FMU project and connecting the data produced by FMU to the official masterdata in SMDA, is done by manually editing the global configuration yaml file. This can be a tedious and error-prone process.
For FMU results to be usable by other applications, they need to be referenced to master data - unique and shared definitions. Configuring these references by manually editing config files can be a tedious and error-prone process. Especially the mapping of stratigraphic data to definitions in the official stratigraphic column has a high risk of typos, and quality checking and validation is difficult.

Especially the mapping of stratigraphic data to official data in SMDA has a high risk of typos, and quality checking and validation is difficult.
Example: A zone called `Upper Tarbert 2.3` in RMS can be equal to a grid zone called `UT2-3` in the simulator, and the corresponding unit in SMDA could be `Tarbert Upper Fm.`. When moving data to cloud (SUMO) these must be connected and identified as the same zone/unit.
Example: A zone called `UpperTarbert23` in RMS can be equal to a grid zone called `UT2-3` in the simulator, and the corresponding unit in SMDA could be `Tarbert Upper Fm.`. When storing data to cloud (Sumo) these must be connected and identified as the same zone/unit.

This process that requires editing yaml files and manually adding master data from official databases does not scale when the amount of data that needs to be mapped increases. FMU Settings is made to address these concerns by offering a simple user interface to configure your FMU project and connect FMU data to the official databases, including validation of the data.
FMU Settings is made to address these concerns by offering a simple user interface to configure your FMU project and connect FMU data to the official databases, including validation of the data.

The need for mapping of FMU data from RMS and simulators to official databases is not limited to stratigraphy, it will also include wells, production data etc.
The need for referencing master data is not limited to stratigraphy. It will also include wells, production data etc.

**FMU Settings can:**

Expand All @@ -31,7 +30,7 @@ By using FMU Settings you get benefits like a **web-based GUI**, **simplified co

| Task | How it is done today | How it will be done in FMU Settings |
| ----- | ---------------------- | ---------------------------------------- |
| Start using SUMO | Manually add masterdata and metadata to global config yaml file. | Run a terminal command to initialize a FMU Settings project. Configuration of masterdata and metadata is then done through the FMU Settings GUI.
| Start using Sumo | Manually add masterdata and metadata to global config yaml file. | Run a terminal command to initialize a FMU Settings project. Configuration of masterdata and metadata is then done through the FMU Settings GUI.
| Add model masterdata | Open SMDA, find field and copy masterdata (on FMU format), manually paste masterdata into yaml file. Prone to errors. | GUI is connected to SMDA, masterdata is fetched and validated in the GUI, and stored to FMU project.
| Add model stratigraphy | Manually add and update stratigraphic column (horizons and zones) in yaml file, based on stratigraphic column in SMDA. Highly prone to errors. | GUI is connected to SMDA and RMS, stratigraphy in RMS and stratigraphic column in SMDA can be mapped in the GUI, creating a consistent stratigraphic column between several data sources.
| Track changes in global config | No version control of global config, all changes are done manually and anyone with access to project area can edit the yaml file. | Tracking of version history and functionality for restoring earlier versions if needed. |
Expand All @@ -44,4 +43,13 @@ This `.fmu` folder is used to store all your project settings and project metada
**NB! You should not edit anything inside the `.fmu` folder manually. All configuration and changes should be done through the FMU Settings GUI!**



From here, continue with [Getting started](getting_started.md).

--------------

```{note}
*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. It is open-source and free software released under the GPL v3 license.*
```