Deploying to gh-pages from @ 2138a92 🚀

master/_sources/common.rst.txt

@@ -1,4 +1,22 @@
 OPM Common Python Documentation
 ===============================
 
+Note on Import Paths
+--------------------
+
+In this documentation, you may notice that some classes are referenced with their full import paths (e.g., opm.io.deck.DeckItem), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:
+
+- Fully Qualified Paths: Classes displayed with their full import paths can be directly imported from their respective modules. For example:
+.. code-block:: python
+
+    from opm.io.deck import DeckItem
+
+
+- Simplified Class Names: Classes displayed with just their names, e.g. Connectoin, are intended for internal use or may require additional context when importing. Refer to the specific module documentation for the correct import path if needed.
+
+This structure allows for a organized and modular package, helping to easily access commonly used classes while maintaining clarity for internal components.
+
+Documentation
+-------------
+
 .. opm_common_docstrings::

master/_sources/flow-in-python.rst.txt

@@ -36,18 +36,16 @@ If you installed in a non-standard directory by specifying -DCMAKE_INSTALL_PREFI
 
 		PYTHONPATH=/opt/opm/lib/python3.11/site-packages python3 spe1case1.py
 
-Here, spe1case1.py could be:
+Here, the example script spe1case1.py could be:
 
 .. code-block:: python
 
-		import os
 		from opm.simulators import BlackOilSimulator
 		from opm.io.parser import Parser
 		from opm.io.ecl_state import EclipseState
 		from opm.io.schedule import Schedule
 		from opm.io.summary import SummaryConfig
 
-		os.chdir("SPE1CASE1")
 		deck  = Parser().parse('SPE1CASE1.DATA')
 		state = EclipseState(deck)
 		schedule = Schedule( deck, state )
@@ -61,3 +59,5 @@ Here, spe1case1.py could be:
 		sim.set_porosity(poro)
 		sim.step()
 		sim.step_cleanup()
+
+where you could use the SPE1CASE1.DATA file from `the opm-test repository <https://github.com/OPM/opm-tests/tree/master/spe1>`_.

master/_sources/index.rst.txt

@@ -7,6 +7,11 @@ There are two Python APIs within OPM Flow:
 - running a Python script embedded in a simulation (see :doc:`embedded-python`)
 
 
+This site further contains the documentation of:
+
+- the classes available from OPM Common (see :doc:`common`)
+- the classes available from OPM Simulators (see :doc:`simulators`)
+
 Contents
 ========
 .. toctree::

master/_sources/simulators.rst.txt

@@ -1,4 +1,18 @@
 OPM Simulators Python Documentation
 ===================================
 
+Note on Import Paths
+--------------------
+
+In this documentation, the BlackOilSimulator class is referenced with its full import path, i.e., opm.simulators.BlackOilSimulator. This reflects how the BlackOilSimulator class can be imported:
+
+.. code-block:: python
+
+    from opm.simulators import BlackOilSimulator
+
+
+Documentation
+-------------
+
+
 .. opm_simulators_docstrings::

master/flow-in-python.html

@@ -109,15 +109,13 @@ <h1>Run OPM Flow from Python<a class="headerlink" href="#run-opm-flow-from-pytho
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">PYTHONPATH</span><span class="o">=</span>/opt/opm/lib/python3.11/site-packages<span class="w"> </span>python3<span class="w"> </span>spe1case1.py
 </pre></div>
 </div>
-<p>Here, spe1case1.py could be:</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
-<span class="kn">from</span> <span class="nn">opm.simulators</span> <span class="kn">import</span> <span class="n">BlackOilSimulator</span>
+<p>Here, the example script spe1case1.py could be:</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">opm.simulators</span> <span class="kn">import</span> <span class="n">BlackOilSimulator</span>
 <span class="kn">from</span> <span class="nn">opm.io.parser</span> <span class="kn">import</span> <span class="n">Parser</span>
 <span class="kn">from</span> <span class="nn">opm.io.ecl_state</span> <span class="kn">import</span> <span class="n">EclipseState</span>
 <span class="kn">from</span> <span class="nn">opm.io.schedule</span> <span class="kn">import</span> <span class="n">Schedule</span>
 <span class="kn">from</span> <span class="nn">opm.io.summary</span> <span class="kn">import</span> <span class="n">SummaryConfig</span>
 
-<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="s2">&quot;SPE1CASE1&quot;</span><span class="p">)</span>
 <span class="n">deck</span>  <span class="o">=</span> <span class="n">Parser</span><span class="p">()</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s1">&#39;SPE1CASE1.DATA&#39;</span><span class="p">)</span>
 <span class="n">state</span> <span class="o">=</span> <span class="n">EclipseState</span><span class="p">(</span><span class="n">deck</span><span class="p">)</span>
 <span class="n">schedule</span> <span class="o">=</span> <span class="n">Schedule</span><span class="p">(</span> <span class="n">deck</span><span class="p">,</span> <span class="n">state</span> <span class="p">)</span>
@@ -133,6 +131,7 @@ <h1>Run OPM Flow from Python<a class="headerlink" href="#run-opm-flow-from-pytho
 <span class="n">sim</span><span class="o">.</span><span class="n">step_cleanup</span><span class="p">()</span>
 </pre></div>
 </div>
+<p>where you could use the SPE1CASE1.DATA file from <a class="reference external" href="https://github.com/OPM/opm-tests/tree/master/spe1">the opm-test repository</a>.</p>
 </section>
 
 

master/index.html

@@ -80,6 +80,11 @@ <h1>Welcome to the Python documentation for OPM Flow!<a class="headerlink" href=
 <li><p>running Flow from Python code using the Python bindings (see <a class="reference internal" href="flow-in-python.html"><span class="doc">Run OPM Flow from Python</span></a>)</p></li>
 <li><p>running a Python script embedded in a simulation (see <a class="reference internal" href="embedded-python.html"><span class="doc">Run Python embedded in OPM Flow</span></a>)</p></li>
 </ul>
+<p>This site further contains the documentation of:</p>
+<ul class="simple">
+<li><p>the classes available from OPM Common (see <a class="reference internal" href="common.html"><span class="doc">OPM Common Python Documentation</span></a>)</p></li>
+<li><p>the classes available from OPM Simulators (see <a class="reference internal" href="simulators.html"><span class="doc">OPM Simulators Python Documentation</span></a>)</p></li>
+</ul>
 </section>
 <section id="contents">
 <h1>Contents<a class="headerlink" href="#contents" title="Link to this heading"></a></h1>

master/simulators.html

@@ -47,26 +47,30 @@
 <li class="toctree-l1"><a class="reference internal" href="embedded-python.html">Run Python embedded in OPM Flow</a></li>
 <li class="toctree-l1"><a class="reference internal" href="common.html">OPM Common Python Documentation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">OPM Simulators Python Documentation</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#opm.simulators.BlackOilSimulator"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator</span></code></a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.__init__"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.__init__()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.__init__()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.advance"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.advance()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.check_simulation_finished"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.check_simulation_finished()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.current_step"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.current_step()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_cell_volumes"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_cell_volumes()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_dt"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_dt()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_fluid_state_variable"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_fluid_state_variable()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_porosity"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_porosity()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_primary_var_meaning"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_primary_var_meaning()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_primary_var_meaning_map"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_primary_var_meaning_map()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_primary_variable"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_primary_variable()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.mpi_init"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.mpi_init()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.run"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.run()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.set_porosity"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.set_porosity()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.set_primary_variable"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.set_primary_variable()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.step"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.step()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.step_cleanup"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.step_cleanup()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.step_init"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.step_init()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#note-on-import-paths">Note on Import Paths</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#opm.simulators.BlackOilSimulator"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.__init__"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.__init__()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.__init__()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.advance"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.advance()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.check_simulation_finished"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.check_simulation_finished()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.current_step"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.current_step()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_cell_volumes"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_cell_volumes()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_dt"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_dt()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_fluid_state_variable"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_fluid_state_variable()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_porosity"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_porosity()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_primary_var_meaning"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_primary_var_meaning()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_primary_var_meaning_map"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_primary_var_meaning_map()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.get_primary_variable"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.get_primary_variable()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.mpi_init"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.mpi_init()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.run"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.run()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.set_porosity"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.set_porosity()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.set_primary_variable"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.set_primary_variable()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.step"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.step()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.step_cleanup"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.step_cleanup()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#opm.simulators.BlackOilSimulator.step_init"><code class="docutils literal notranslate"><span class="pre">opm.simulators.BlackOilSimulator.step_init()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
@@ -99,6 +103,15 @@
 
   <section id="opm-simulators-python-documentation">
 <h1>OPM Simulators Python Documentation<a class="headerlink" href="#opm-simulators-python-documentation" title="Link to this heading"></a></h1>
+<section id="note-on-import-paths">
+<h2>Note on Import Paths<a class="headerlink" href="#note-on-import-paths" title="Link to this heading"></a></h2>
+<p>In this documentation, the BlackOilSimulator class is referenced with its full import path, i.e., opm.simulators.BlackOilSimulator. This reflects how the BlackOilSimulator class can be imported:</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">opm.simulators</span> <span class="kn">import</span> <span class="n">BlackOilSimulator</span>
+</pre></div>
+</div>
+</section>
+<section id="documentation">
+<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="opm.simulators.BlackOilSimulator">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">opm.simulators.</span></span><span class="sig-name descname"><span class="pre">BlackOilSimulator</span></span><a class="headerlink" href="#opm.simulators.BlackOilSimulator" title="Link to this definition"></a></dt>
@@ -340,6 +353,7 @@ <h1>OPM Simulators Python Documentation<a class="headerlink" href="#opm-simulato
 </dl>
 </dd></dl>
 
+</section>
 </section>