Skip to content

Commit 7922491

Browse files
krhartkrhart
committed
DOC: Add FAQ page
1 parent da0b6f5 commit 7922491

2 files changed

Lines changed: 143 additions & 1 deletion

File tree

‎docs/src/faq.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<style>
2+
summary {
3+
font-size: 1em;
4+
font-weight: bold;
5+
cursor: pointer;
6+
}
7+
</style>
8+
9+
10+
# FAQ
11+
12+
13+
## General
14+
<details>
15+
<summary>Why do I have to use FMU Settings</summary>
16+
FMU Settings replaces parts of the tedious and error-prone process of manually editing the global configuration file by providing a simple user interface for configuring your FMU project. It connects FMU data to official databases, including validation of the data. See documentation <a href="https://equinor.github.io/fmu-settings/overview.html">here</a>.
17+
</details>
18+
19+
<details>
20+
<summary>What is SMDA?</summary>
21+
<a href="https://smda.equinor.com/">SMDA</a> is Equinor's official database for subsurface master data (ex. field name, well name, stratigraphic element names etc.)
22+
</details>
23+
24+
<details>
25+
<summary>Who can I reach out to if I don't find answers to my questions in the documentation pages?</summary>
26+
If you need support you can reach out to the development team in the Slack channel <a href="https://equinor.enterprise.slack.com/archives/C09MFKN4NC9">fmu-settings</a> or you can post a question in the Viva Engage group <a href="https://engage.cloud.microsoft/main/org/statoil.com/groups/eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI3OTMyMjAxIn0">FMU Users</a>.
27+
</details>
28+
29+
<details>
30+
<summary>Can I use FMU Settings if my Field is not in SMDA?</summary>
31+
No. Your field must be in SMDA for you to be able to use FMU Settings, as FMU Settings connects to SMDA for setting project masterdata, and for mapping of stratigraphy and wells to official names.
32+
</details>
33+
34+
<details>
35+
<summary>Can I use FMU Settings if my asset is not in enrolled in Sumo yet?</summary>
36+
Yes. You can use FMU Settings even if your field/asset is not yet enrolled to Sumo. It will add metadata to your FMU results stored on the scratch disk. However, you will not be able to use cloud based-tools like Webviz or REP if your project is not in Sumo and your data is uploaded to Sumo as part of your ERT run.
37+
</details>
38+
39+
<details>
40+
<summary>Can two users run FMU Settings on the same project at the same time?</summary>
41+
Yes. More than one user can have the application open at the same time. However, to avoid people overwriting each other’s work, only one user can make edits at a time. The project can be either editable or read-only. If the project is read-only, try Enable editing. If someone else is already editing, FMU Settings shows who currently holds the lock.
42+
</details>
43+
44+
<details>
45+
<summary>Can I keep all settings in my global config and still use FMU Settings?</summary>
46+
If you have one or more of these sections in your <code>global_master_config.yml</code> file you should remove them (and the corresponding files in <code>/fmuconfig/input</code>):
47+
<ul>
48+
<li>model</li>
49+
<li>masterdata</li>
50+
<li>stratigraphy</li>
51+
<li>access</li> </ul>
52+
</details>
53+
54+
<details>
55+
<summary>I have just started using FMU Settings. What do I need to change in my FMU model to be able to run everything?</summary>
56+
If you have one or more of these sections in your <code>global_master_config.yml</code> file you should remove them (and the corresponding files in <code>/fmuconfig/input</code>):
57+
<ul>
58+
<li>model</li>
59+
<li>masterdata</li>
60+
<li>stratigraphy</li>
61+
<li>access</li> </ul>
62+
If you don't have these sections in your <code>global_master_config.yml</code> you do not need to change anything, you're good to go!
63+
</details>
64+
65+
66+
## Initialization and Getting Started
67+
<details>
68+
<summary>Why is the list of projects to open empty?</summary>
69+
If FMU Settings opens without a project available in the dropdown list, it is because you have not initialized the project first. Check the Getting Started page on how to initialize FMU Settings.
70+
</details>
71+
72+
<details>
73+
<summary>Why is my project opened in read only mode?</summary>
74+
An FMU Settings project will always open in read-only mode, and you have to specifically enable editing to be able to edit anything. By enabling edit mode a lock file will be created for your user, preventing other users from editing the project at the same time. This lock file will expire after a given time period and you will be asked if you want to keep working or release the lock file. This is similar to what you are used to with RMS and RMS lock files.
75+
</details>
76+
77+
78+
## RMS project
79+
<details>
80+
<summary>What does it mean to access the RMS project from within FMU Settings?</summary>
81+
To be able to edit the stratigraphy and the wellbores sections in FMU Settings you must establish the connection between FMU Settings and RMS, making RMS accessible for FMU Settings to read from. Due to a limited number of RMS licenses and license limitations, RMS is not opened by default when FMU Settings is opened. When you access the RMS project you will have an open connection to RMS for 2 hours, before the RMS connection will be automatically closed.
82+
</details>
83+
84+
85+
## Masterdata
86+
<details>
87+
<summary>Why can't I see my field when I search for it?</summary>
88+
If your field is not available in the list it means that your field is not in SMDA. To be able to map your project to official masterdata your field must exist in SMDA. See <a href="https://equinor.github.io/fmu-settings/overview.html">here</a>.
89+
</details>
90+
91+
<details>
92+
<summary>Can I add a stratigraphic column from a neighboring field when my field does not have its own stratigraphic column?</summary>
93+
No. Adding a stratigraphic column from a neighboring field is not possible. To be able to add a stratigraphic column your field must have at least one stratigraphic column in SMDA.
94+
</details>
95+
96+
97+
## Mapping
98+
<details>
99+
<summary>I have updated my stratigraphic framework in RMS. What do I need to do in FMU Settings to include the updated stratigraphy in my project?</summary>
100+
If you have made changes to the stratigraphic column in RMS you must open FMU Settings for your project, access the RMS project, and then add and/or remove horizons and zones accordingly. If you have added horizons and/or zones these must also be mapped, see the stratigraphy mapping page.
101+
</details>
102+
103+
<details>
104+
<summary>I have added new wells to RMS. What do I need to do in FMU Settings to add the new wells to my project?</summary>
105+
If you have made changes to the wells in RMS you must open FMU Settings for your project, access the RMS project, and then add and/or remove wells accordingly. If you have added one or more wells, these must also be mapped, see the wellbore mapping page.
106+
</details>
107+
108+
<details>
109+
<summary>Do I have to map my RMS wells to Simulator wells to be able to visualize my wells in Webviz?</summary>
110+
No. Mapping wellbores between RMS and Simulator is optional. If you want to upload RMS wells to SUMO (for instance to be able to visualize them in Webviz), the only mandatory step is to map the RMS well names to SMDA well names.
111+
</details>
112+
113+
114+
## Synchronization between projects
115+
<details>
116+
<summary>I have made changes to FMU Settings in my user copy. How can I merge these changes into the Master project?</summary>
117+
To copy FMU Settings from one revision to another, you can use the terminal command <code>fmu sync</code>. See the documentation for instructions on how to use this command <a href="https://equinor.github.io/fmu-settings/terminal_commands.html">here</a>.
118+
</details>
119+
120+
<details>
121+
<summary>I merged FMU Settings from my user revision to the master revision by accident. What should I do to roll back to a previous version?</summary>
122+
If you have saved changes in FMU Settings, you will have previous versions stored as snapshots on the History page. Here you can pick a previous version (snapshot) and restore it. The current version will then be overwritten by the snapshot version you have chosen.
123+
</details>
124+
125+
126+
## Access and Authentication
127+
<details>
128+
<summary>Why do I have to log on and authenticate every time I want to make changes to my project's masterdata?</summary>
129+
You have to log on and authenticate to be able to access data in SMDA.
130+
</details>
131+
132+
133+
## Troubleshooting
134+
<details>
135+
<summary>I have edited something in my .fmu folder manually. Is there a way to get back a previous version?</summary>
136+
No, which also is also why users should never edit the content of .fmu manually.
137+
</details>
138+
139+
<details>
140+
<summary>When I open FMU Settings it seems to be an empty project and it shows an error message saying "Network error". What is wrong?</summary>
141+
If you get an empty project and a network error when opening FMU Settings, try performing a hard refresh of your browser (Ctrl + Shift + R)
142+
</details>

‎docs/src/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ overview.md
3535
getting_started.md
3636
gui_user_guide.md
3737
terminal_commands.md
38-
data_models.md
38+
faq.md
3939
4040
```

0 commit comments

Comments
 (0)