Skip to content

Commit

Permalink
DOC: Header alignment and fixups (equinor#478)
Browse files Browse the repository at this point in the history
  • Loading branch information
perolavsvendsen authored Feb 20, 2024
1 parent ffc778d commit 1082ad0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 12 deletions.
6 changes: 0 additions & 6 deletions docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,3 @@ from a relational database (where this information would typically be stored onc
referred to when needed).

The FMU results data model is further documented `here <./datamodel.html>`__

Getting started
===============

To get started, your FMU workflow must be retrofitted with a few improvements further
described `here <./preparations.html>`__
13 changes: 7 additions & 6 deletions docs/preparations.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Use fmu-dataio in an FMU workflow
=================================
Getting started
===============

In order to start using fmu-dataio and produce rich metadata for FMU output, some
preparations are necessary to your workflow. Expected time consumption is less than an hour.
Expand Down Expand Up @@ -132,7 +132,7 @@ that there can be only one stratigraphic column, so this entry is *not* a list.
or someone else who normally do work within OpenWorks.

global_variables.yml | **access**
=================================
---------------------------------

Next, create ``_access.yml``. In this file, you will enter some information related
to how FMU results from your workflow are to be governed when it comes to access rights.
Expand All @@ -155,7 +155,7 @@ Sumo, you will be told by the Sumo team what asset should be.
.. note::
"I cannot find asset in SMDA, and why does asset not have a unique ID"?

Currently, "asset" is not covered by master data/SMDA. However, it is a vitally important
Currently, "asset" is not in our masterdata. However, it is an important
piece of information that governs both ownership and access to data when stored in the
cloud. Sometimes, asset is identical to "field" but frequently it is not.

Expand All @@ -167,7 +167,7 @@ Note that you can override this default setting at any point when exporting data
note that no data will be lifted to the lake without explicit action by you.

global_variables.yml | **stratigraphy**
=======================================
---------------------------------------

Finally, establish ``_stratigraphy.yml``. This is a bit more heavy, and relates to the
``stratigraphic_column`` referred to earlier. In short, when applicable, stratigraphic intervals
Expand Down Expand Up @@ -230,7 +230,8 @@ From the Drogon tutorial:
might see validation errors then if you have made mistakes here.

global_variables.yml | **model**
================================
--------------------------------

Now we insert the ``model`` entry in ``global_variables.yml``.

``model`` block contains basic information about the model. According to the FMU standard,
Expand Down

0 comments on commit 1082ad0

Please sign in to comment.