DOC: Iterate on documentation. by perolavsvendsen · Pull Request #275 · equinor/fmu-settings

perolavsvendsen · 2026-06-16T13:45:48Z

A few iterations on the documentation. Highlights:

Reduced references to other applications, and included information about the RMS trademark
Clarified that stratigraphy is mapped to the stratigraphic column (which is stored in SMDA), not to SMDA (which is the database)
Minor linguistic improvements (?) here and there.
- "SUMO" --> "Sumo"

Checklist

perolavsvendsen · 2026-06-16T13:46:35Z


 You have now initialized FMU Settings.

-   >##### Important:


Replaced with build-in notification

perolavsvendsen · 2026-06-16T13:47:13Z

 ## 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 official definitions in the stratigraphic column has a high risk of typos, and quality checking and validation is difficult.


Added a bit of info on why master data matters

perolavsvendsen · 2026-06-16T13:52:38Z

 - <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


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

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.

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 👍

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

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

perolavsvendsen · 2026-06-16T13:53:05Z


-If an RMS zone or horizon does not exist in SMDA, select “Zone does not exist in SMDA”.
-
-#### Upcoming feature: Automatic mapping


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

perolavsvendsen · 2026-06-16T13:53:19Z

 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. 


Changed to native tip box

krhart · 2026-06-16T16:01:48Z

I'm not sure I agree with the SMDA vs stratigraphic column issue. In my head, stratigraphic column is very generic and just a schema/diagram that you use to sort the order of the stratigraphic elements. So RMS have it, OW have it, SMDA have it, etc. But maybe "official stratigraphic column" could work? On the other hand, I think it would be good that the users are familiar with SMDA anyway, and that SMDA is the official source of metadata. So if they don't know before, they will know after using FMU Settings.

perolavsvendsen · 2026-06-17T06:37:58Z

I'm not sure I agree with the SMDA vs stratigraphic column issue. (...)

Yes, good points. And in hindsight, this part should probably have been a separate issue -> PR. Got carried away in editing mode... Have clarified it a bit more now. If more discussion is needed, I can reduce this PR to the "obvious" things only.

GibranAlfa · 2026-06-17T12:49:42Z

 - <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


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.

Co-authored-by: Gibran Alfarizi <52709954+GibranAlfa@users.noreply.github.com>

perolavsvendsen · 2026-06-18T12:42:56Z

As more discussion is possibly required on this PR, I suggest this be merged as a first step.

slangeveld

Except from this SMDA vs stratigraphic column discussion we need to agree on, the rest looks good from my point of view.

@tnatt What is your take on this?

slangeveld · 2026-07-17T08:37:20Z

 - <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


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

tnatt

We should decide on whether we use SMDA stratigraphic column or stratigraphic column in SMDA, other than that these updates LGTM 🙂

tnatt · 2026-08-05T12:19:24Z

 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


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.

tnatt · 2026-08-05T12:29:19Z

 # 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).


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).

perolavsvendsen commented Jun 16, 2026

View reviewed changes

DOC: Iterate on documentation.

fc0a8b4

perolavsvendsen force-pushed the crazy-horse branch from 1dc258d to fc0a8b4 Compare June 16, 2026 13:51

perolavsvendsen commented Jun 16, 2026

View reviewed changes

perolavsvendsen requested review from krhart, slangeveld and tnatt June 16, 2026 13:54

DOC: Clarify SMDA and stratigraphic column.

344ea1f

GibranAlfa reviewed Jun 17, 2026

View reviewed changes

perolavsvendsen and others added 2 commits June 17, 2026 14:55

Update docs/src/gui_user_guide.md

0ad82aa

Co-authored-by: Gibran Alfarizi <52709954+GibranAlfa@users.noreply.github.com>

DOC: Add horizon doesn't exist in SMDA select option

6a2f26f

slangeveld reviewed Jul 17, 2026

View reviewed changes

tnatt approved these changes Aug 6, 2026

View reviewed changes


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

		#### Upcoming feature: Automatic mapping

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

	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).

Uh oh!

Conversation

perolavsvendsen commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krhart commented Jun 16, 2026

Uh oh!

perolavsvendsen commented Jun 17, 2026

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

perolavsvendsen commented Jun 18, 2026

Uh oh!

slangeveld left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tnatt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

perolavsvendsen commented Jun 16, 2026 •

edited

Loading

slangeveld left a comment •

edited

Loading