Update Github Pages

Author: fmu-config-github-action

_sources/examples.rst.txt

@@ -59,19 +59,19 @@ IPL example
 """""""""""
 .. code-block:: text
 
-   Include("../input/global_variables/global_variables.ipl")
+   Include("../../fmuconfig/output/global_variables.ipl")
 
-   FOR i FROM 1 TO TOP_LOBE.length DO
+   FOR i FROM 1 TO TOP_LOBES.length DO
        Print("Reading ", TOP_LOBE[i])
 
 
-Python example
-""""""""""""""
+Python example (using yaml_load)
+""""""""""""""""""""""""""""""""
 .. code-block:: python
 
    import fmu.config.utilities as utils
 
-   cfg = utils.yaml_load('../input/global_variables/global_variables_rms.yml')
+   CFG = utils.yaml_load('../../fmuconfig/output/global_variables.yml')
 
-   for toplobe in cfg['horizons']['TOP_LOBE']:
+   for toplobe in CFG["rms"]["horizons"]["TOP_LOBES"]:
        print('Working with {}'.format(toplobe))

_sources/index.rst.txt

@@ -11,12 +11,7 @@ Welcome to fmu-config's documentation!
    examples
    contributing
 
-API
-===
 
-.. toctree::
-
-   fmu.config/fmu.config
 
 Indices and tables
 ==================

_sources/usage.rst.txt

@@ -105,3 +105,30 @@ need to initiate the Class instance and run a few methods. Here is an example:
    if __name__ == "__main__":
       cleanup()
       main()
+
+Using the output YAML in RMS or scripts
+---------------------------------------
+
+.. code-block:: python
+
+   from fmu.config import utilities as util
+
+   CONFIG = "../../fmuconfig/output/global_variables.yml"
+
+   CFG = util.yaml_load(CONFIG)
+
+
+Loading the input YAML in RMS or scripts
+----------------------------------------
+
+In some cases we may need to load the 'input' version of the YAML files which in fmu.config has
+a syntax (e.g. the ``!include`` keys) which makes it not compatible with the YAML standard.
+The solution then is to use a ``loader="FMU"`` key-value:
+
+.. code-block:: python
+
+   from fmu.config import utilities as util
+
+   CONFIG = "../../fmuconfig/input/global_master_variables.yml"
+
+   CFG = util.yaml_load(CONFIG, loader="FMU")

_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.3.1.dev3+g73292c8',
+    VERSION: '1.3.1.dev4+gdccab8a',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

contributing.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; fmu-config 1.3.1.dev3+g73292c8 documentation</title>
+  <title>Contributing &mdash; fmu-config 1.3.1.dev4+gdccab8a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=cd9e2648"></script>
+      <script src="_static/documentation_options.js?v=46fa796f"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -57,11 +57,11 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#code-standards">Code standards</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#in-addition">In addition:</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#in-addition">In addition</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#linting">Linting</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#get-started">Get Started!</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#get-started">Get Started</a></li>
 </ul>
 </li>
 </ul>
@@ -99,7 +99,7 @@ <h1>Contributing<a class="headerlink" href="#contributing" title="Link to this h
 <h2>Types of Contributions<a class="headerlink" href="#types-of-contributions" title="Link to this heading"></a></h2>
 <section id="report-bugs">
 <h3>Report Bugs<a class="headerlink" href="#report-bugs" title="Link to this heading"></a></h3>
-<p>Report issues and bugs at https://github.com/equinor/fmu-config/issues</p>
+<p>Report issues and bugs at <a class="reference external" href="https://github.com/equinor/fmu-config/issues">fmu-config/issues</a></p>
 <p>If you are reporting a bug, please include:</p>
 <ul class="simple">
 <li><p>Your operating system name and version.</p></li>
@@ -125,8 +125,7 @@ <h3>Write Documentation<a class="headerlink" href="#write-documentation" title="
 </section>
 <section id="submit-feedback">
 <h3>Submit Feedback<a class="headerlink" href="#submit-feedback" title="Link to this heading"></a></h3>
-<p>The best way to send feedback is to file an issue
-at https://github.com/equinor/fmu-config/issues.</p>
+<p>The best way to send feedback is to file an issue at <a class="reference external" href="https://github.com/equinor/fmu-config/issues">fmu-config/issues</a></p>
 <p>If you are proposing a feature:</p>
 <ul class="simple">
 <li><p>Explain in detail how it would work.</p></li>
@@ -142,7 +141,7 @@ <h2>Code standards<a class="headerlink" href="#code-standards" title="Link to th
 <a class="reference external" href="https://pypi.org/project/ruff/">ruff</a>,
 <a class="reference external" href="https://mypy.readthedocs.io/en/stable/">mypy</a> to format and lint all code.</p>
 <section id="in-addition">
-<h3>In addition:<a class="headerlink" href="#in-addition" title="Link to this heading"></a></h3>
+<h3>In addition<a class="headerlink" href="#in-addition" title="Link to this heading"></a></h3>
 <ul class="simple">
 <li><p>Start with documentation and tests. Think and communicate first!</p></li>
 <li><p>Docstrings shall start and end with “”” and use Google style.</p></li>
@@ -162,7 +161,7 @@ <h3>Linting<a class="headerlink" href="#linting" title="Link to this heading">
 </section>
 </section>
 <section id="get-started">
-<h2>Get Started!<a class="headerlink" href="#get-started" title="Link to this heading"></a></h2>
+<h2>Get Started<a class="headerlink" href="#get-started" title="Link to this heading"></a></h2>
 <p>Ready to contribute? Here’s how to set up <code class="docutils literal notranslate"><span class="pre">fmu-config</span></code> for local development.</p>
 <ol class="arabic">
 <li><p>Fork the <code class="docutils literal notranslate"><span class="pre">fmu-config</span></code> repo in web browser to a personal fork</p></li>

examples.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Examples to learn from &mdash; fmu-config 1.3.1.dev3+g73292c8 documentation</title>
+  <title>Examples to learn from &mdash; fmu-config 1.3.1.dev4+gdccab8a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=cd9e2648"></script>
+      <script src="_static/documentation_options.js?v=46fa796f"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -56,7 +56,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#vinstre-example-config">Vinstre example config</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#using-the-config-in-rms-ipl-and-python">Using the config in RMS, IPL and Python</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#ipl-example">IPL example</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#python-example">Python example</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#python-example-using-yaml-load">Python example (using yaml_load)</a></li>
 </ul>
 </li>
 </ul>
@@ -543,20 +543,20 @@ <h2>Vinstre example config<a class="headerlink" href="#vinstre-example-config" t
 <h2>Using the config in RMS, IPL and Python<a class="headerlink" href="#using-the-config-in-rms-ipl-and-python" title="Link to this heading"></a></h2>
 <section id="ipl-example">
 <h3>IPL example<a class="headerlink" href="#ipl-example" title="Link to this heading"></a></h3>
-<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Include(&quot;../input/global_variables/global_variables.ipl&quot;)
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Include(&quot;../../fmuconfig/output/global_variables.ipl&quot;)
 
-FOR i FROM 1 TO TOP_LOBE.length DO
+FOR i FROM 1 TO TOP_LOBES.length DO
     Print(&quot;Reading &quot;, TOP_LOBE[i])
 </pre></div>
 </div>
 </section>
-<section id="python-example">
-<h3>Python example<a class="headerlink" href="#python-example" title="Link to this heading"></a></h3>
+<section id="python-example-using-yaml-load">
+<h3>Python example (using yaml_load)<a class="headerlink" href="#python-example-using-yaml-load" title="Link to this heading"></a></h3>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">fmu.config.utilities</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">utils</span>
 
-<span class="n">cfg</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">yaml_load</span><span class="p">(</span><span class="s1">&#39;../input/global_variables/global_variables_rms.yml&#39;</span><span class="p">)</span>
+<span class="n">CFG</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">yaml_load</span><span class="p">(</span><span class="s1">&#39;../../fmuconfig/output/global_variables.yml&#39;</span><span class="p">)</span>
 
-<span class="k">for</span> <span class="n">toplobe</span> <span class="ow">in</span> <span class="n">cfg</span><span class="p">[</span><span class="s1">&#39;horizons&#39;</span><span class="p">][</span><span class="s1">&#39;TOP_LOBE&#39;</span><span class="p">]:</span>
+<span class="k">for</span> <span class="n">toplobe</span> <span class="ow">in</span> <span class="n">CFG</span><span class="p">[</span><span class="s2">&quot;rms&quot;</span><span class="p">][</span><span class="s2">&quot;horizons&quot;</span><span class="p">][</span><span class="s2">&quot;TOP_LOBES&quot;</span><span class="p">]:</span>
     <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Working with </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">toplobe</span><span class="p">))</span>
 </pre></div>
 </div>

genindex.html

@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; fmu-config 1.3.1.dev3+g73292c8 documentation</title>
+  <title>Index &mdash; fmu-config 1.3.1.dev4+gdccab8a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=cd9e2648"></script>
+      <script src="_static/documentation_options.js?v=46fa796f"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

index.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to fmu-config’s documentation! &mdash; fmu-config 1.3.1.dev3+g73292c8 documentation</title>
+  <title>Welcome to fmu-config’s documentation! &mdash; fmu-config 1.3.1.dev4+gdccab8a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=cd9e2648"></script>
+      <script src="_static/documentation_options.js?v=46fa796f"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -96,6 +96,8 @@ <h1>Welcome to fmu-config’s documentation!<a class="headerlink" href="#welcome
 <li class="toctree-l2"><a class="reference internal" href="usage.html#folder-structure">Folder structure</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usage.html#run-from-script">Run from script</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usage.html#run-from-python-inside-or-outside-rms">Run from python inside or outside RMS</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage.html#using-the-output-yaml-in-rms-or-scripts">Using the output YAML in RMS or scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage.html#loading-the-input-yaml-in-rms-or-scripts">Loading the input YAML in RMS or scripts</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples to learn from</a><ul>
@@ -107,17 +109,12 @@ <h1>Welcome to fmu-config’s documentation!<a class="headerlink" href="#welcome
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#types-of-contributions">Types of Contributions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#code-standards">Code standards</a></li>
-<li class="toctree-l2"><a class="reference internal" href="contributing.html#get-started">Get Started!</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#get-started">Get Started</a></li>
 </ul>
 </li>
 </ul>
 </div>
 </section>
-<section id="api">
-<h1>API<a class="headerlink" href="#api" title="Link to this heading"></a></h1>
-<div class="toctree-wrapper compound">
-</div>
-</section>
 <section id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
 <ul class="simple">

installation.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; fmu-config 1.3.1.dev3+g73292c8 documentation</title>
+  <title>Installation &mdash; fmu-config 1.3.1.dev4+gdccab8a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=cd9e2648"></script>
+      <script src="_static/documentation_options.js?v=46fa796f"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

objects.inv

@@ -1,5 +1,5 @@
 # Sphinx inventory version 2
 # Project: fmu-config
-# Version: 1.3.1.dev3+g73292c8
+# Version: 1.3.1.dev4+gdccab8a
 # The remainder of this file is compressed using zlib.
 xڅ�Aj!E�����fB���t��Jk�2L�r�\/'��Ӵ�lD�W~KM��;eva��ͽ!-�;�;�vb��S\�?#�Y�fZLA� m$/F.�, �`EW���u+6۵�x����>%�u���w�ś=V�(ܔ&��r������M��)��s ��y��?�q���ѩ�HO{�i�ym��A�T��5��|ou+f��R�{ۦ6����EZW2�`�%4S���2�2�$~
)�Y