-
Notifications
You must be signed in to change notification settings - Fork 8
DOC: Iterate on documentation. #275
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
fc0a8b4
344ea1f
0ad82aa
6a2f26f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,12 +25,15 @@ fmu init | |
|
|
||
| You have now initialized FMU Settings. | ||
|
|
||
| >##### 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. | ||
|
|
||
| ```{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 | ||
|
|
@@ -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. | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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). | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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 | ||||||
|
|
@@ -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 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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
I see we sometimes write it like this, but most places we say |
||||||
|
|
||||||
| 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 | ||||||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||||||
|
|
||||||
| 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). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 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). | ||||||
|
|
@@ -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 | ||||||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed this as it felt a bit misplaced in the documentation (?)
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 👍
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||||||
|
|
||||||
There was a problem hiding this comment.
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