Update GitHub pages

_modules/volue/mesh/_connection.html

@@ -202,7 +202,9 @@ <h1>Source code for volue.mesh._connection</h1><div class="highlight"><pre>
     <span class="n">_to_proto_guid</span><span class="p">,</span>
     <span class="n">_from_proto_guid</span><span class="p">,</span>
     <span class="n">_to_proto_timeseries</span><span class="p">,</span>
+    <span class="n">_to_proto_utcinterval</span><span class="p">,</span>
 <span class="p">)</span>
+<span class="kn">from</span> <span class="nn">volue.mesh._mesh_id</span> <span class="kn">import</span> <span class="n">_to_proto_object_mesh_id</span>
 <span class="kn">from</span> <span class="nn">volue.mesh.calc.forecast</span> <span class="kn">import</span> <span class="n">ForecastFunctions</span>
 <span class="kn">from</span> <span class="nn">volue.mesh.calc.history</span> <span class="kn">import</span> <span class="n">HistoryFunctions</span>
 <span class="kn">from</span> <span class="nn">volue.mesh.calc.statistical</span> <span class="kn">import</span> <span class="n">StatisticalFunctions</span>
@@ -544,7 +546,34 @@ <h1>Source code for volue.mesh._connection</h1><div class="highlight"><pre>
             <span class="n">request</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_prepare_update_rating_curve_versions_request</span><span class="p">(</span>
                 <span class="n">target</span><span class="p">,</span> <span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">,</span> <span class="n">new_versions</span>
             <span class="p">)</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">mesh_service</span><span class="o">.</span><span class="n">UpdateRatingCurveVersions</span><span class="p">(</span><span class="n">request</span><span class="p">)</span></div></div>
+            <span class="bp">self</span><span class="o">.</span><span class="n">mesh_service</span><span class="o">.</span><span class="n">UpdateRatingCurveVersions</span><span class="p">(</span><span class="n">request</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Connection.Session.run_simulation"><a class="viewcode-back" href="../../../api.html#volue.mesh.Connection.Session.run_simulation">[docs]</a>        <span class="k">def</span> <span class="nf">run_simulation</span><span class="p">(</span>
+            <span class="bp">self</span><span class="p">,</span>
+            <span class="n">model</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+            <span class="n">case_group</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+            <span class="n">case</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+            <span class="n">start_time</span><span class="p">:</span> <span class="n">datetime</span><span class="p">,</span>
+            <span class="n">end_time</span><span class="p">:</span> <span class="n">datetime</span><span class="p">,</span>
+            <span class="n">resolution</span><span class="p">:</span> <span class="n">Timeseries</span><span class="o">.</span><span class="n">Resolution</span><span class="p">,</span>
+            <span class="n">scenario</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
+            <span class="n">return_datasets</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
+        <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Iterator</span><span class="p">[</span><span class="kc">None</span><span class="p">]:</span>
+            <span class="k">if</span> <span class="n">start_time</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">end_time</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;start_time and end_time must both have a value&quot;</span><span class="p">)</span>
+
+            <span class="n">simulation</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Model/</span><span class="si">{</span><span class="n">model</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">case_group</span><span class="si">}</span><span class="s2">.has_OptimisationCases/</span><span class="si">{</span><span class="n">case</span><span class="si">}</span><span class="s2">.has_OptimisationParameters/Optimal.has_HydroSimulation/HydroSimulation&quot;</span>
+
+            <span class="n">request</span> <span class="o">=</span> <span class="n">core_pb2</span><span class="o">.</span><span class="n">SimulationRequest</span><span class="p">(</span>
+                <span class="n">session_id</span><span class="o">=</span><span class="n">_to_proto_guid</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">session_id</span><span class="p">),</span>
+                <span class="n">simulation</span><span class="o">=</span><span class="n">_to_proto_object_mesh_id</span><span class="p">(</span><span class="n">simulation</span><span class="p">),</span>
+                <span class="n">interval</span><span class="o">=</span><span class="n">_to_proto_utcinterval</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">),</span>
+                <span class="n">scenario</span><span class="o">=</span><span class="n">scenario</span><span class="p">,</span>
+                <span class="n">return_datasets</span><span class="o">=</span><span class="n">return_datasets</span><span class="p">,</span>
+            <span class="p">)</span>
+
+            <span class="k">for</span> <span class="n">response</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">mesh_service</span><span class="o">.</span><span class="n">RunHydroSimulation</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
+                <span class="k">yield</span> <span class="kc">None</span></div></div>
 
     <span class="nd">@staticmethod</span>
     <span class="k">def</span> <span class="nf">_secure_grpc_channel</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>

_sources/examples.rst.txt

@@ -103,3 +103,8 @@ Write time series, asynchronously
 .. literalinclude:: /../../src/volue/mesh/examples/write_timeseries_points_async.py
    :language: python
 
+Run simulations
+***************
+.. literalinclude:: /../../src/volue/mesh/examples/run_simulation.py
+   :language: python
+

api.html

@@ -823,6 +823,11 @@ <h1>API documentation<a class="headerlink" href="#api-documentation" title="Perm
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="volue.mesh.Connection.Session.run_simulation">
+<span class="sig-name descname"><span class="pre">run_simulation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">case</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)"><span class="pre">datetime.datetime</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)"><span class="pre">datetime.datetime</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#volue.mesh.Timeseries.Resolution" title="volue.mesh._timeseries.Timeseries.Resolution"><span class="pre">volue.mesh._timeseries.Timeseries.Resolution</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">scenario</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_datasets</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.12)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/volue/mesh/_connection.html#Connection.Session.run_simulation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#volue.mesh.Connection.Session.run_simulation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="volue.mesh.Connection.Session.search_for_attributes">
 <span class="sig-name descname"><span class="pre">search_for_attributes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/uuid.html#uuid.UUID" title="(in Python v3.12)"><span class="pre">uuid.UUID</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#volue.mesh.Object" title="volue.mesh._object.Object"><span class="pre">volue.mesh._object.Object</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">full_attribute_info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#volue.mesh.AttributeBase" title="volue.mesh._attribute.AttributeBase"><span class="pre">volue.mesh._attribute.AttributeBase</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/volue/mesh/_connection.html#Connection.Session.search_for_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#volue.mesh.Connection.Session.search_for_attributes" title="Permalink to this definition">¶</a></dt>

examples.html

@@ -114,6 +114,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#working-with-xy-sets">Working with XY sets</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#write-time-series">Write time series</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#write-time-series-asynchronously">Write time series, asynchronously</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#run-simulations">Run simulations</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="authentication.html">Client authentication</a></li>
@@ -1759,6 +1760,40 @@ <h2>Write time series, asynchronously<a class="headerlink" href="#write-time-ser
 </pre></div>
 </div>
 </div>
+<div class="section" id="run-simulations">
+<h2>Run simulations<a class="headerlink" href="#run-simulations" title="Permalink to this headline">¶</a></h2>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
+
+<span class="kn">from</span> <span class="nn">volue</span> <span class="kn">import</span> <span class="n">mesh</span>
+<span class="kn">from</span> <span class="nn">volue.mesh.examples</span> <span class="kn">import</span> <span class="n">_get_connection_info</span>
+
+
+<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">address</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">root_pem_certificate</span><span class="p">):</span>
+    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;connecting...&quot;</span><span class="p">)</span>
+    <span class="n">connection</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="n">address</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">root_pem_certificate</span><span class="p">)</span>
+
+    <span class="k">with</span> <span class="n">connection</span><span class="o">.</span><span class="n">create_session</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
+        <span class="n">start_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2023</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+        <span class="n">end_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2023</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;running simulation...&quot;</span><span class="p">)</span>
+
+        <span class="k">try</span><span class="p">:</span>
+            <span class="k">for</span> <span class="n">response</span> <span class="ow">in</span> <span class="n">session</span><span class="o">.</span><span class="n">run_simulation</span><span class="p">(</span>
+                <span class="s2">&quot;Mesh&quot;</span><span class="p">,</span> <span class="s2">&quot;Cases&quot;</span><span class="p">,</span> <span class="s2">&quot;Demo&quot;</span><span class="p">,</span> <span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">False</span>
+            <span class="p">):</span>
+                <span class="k">pass</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;done&quot;</span><span class="p">)</span>
+        <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+            <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;failed to run simulation: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+
+
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
+    <span class="n">address</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">root_pem_certificate</span> <span class="o">=</span> <span class="n">_get_connection_info</span><span class="p">()</span>
+    <span class="n">main</span><span class="p">(</span><span class="n">address</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">root_pem_certificate</span><span class="p">)</span>
+</pre></div>
+</div>
+</div>
 </div>
 
 

genindex.html

@@ -642,6 +642,8 @@ <h2 id="R">R</h2>
         <li><a href="api.html#volue.mesh.Connection.Session.rollback">(volue.mesh.Connection.Session method)</a>
 </li>
       </ul></li>
+      <li><a href="api.html#volue.mesh.Connection.Session.run_simulation">run_simulation() (volue.mesh.Connection.Session method)</a>
+</li>
   </ul></td>
 </tr></table>
 

index.html

@@ -273,6 +273,7 @@ <h2>Getting help<a class="headerlink" href="#getting-help" title="Permalink to t
 <li class="toctree-l2"><a class="reference internal" href="examples.html#working-with-xy-sets">Working with XY sets</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples.html#write-time-series">Write time series</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples.html#write-time-series-asynchronously">Write time series, asynchronously</a></li>
+<li class="toctree-l2"><a class="reference internal" href="examples.html#run-simulations">Run simulations</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="authentication.html">Client authentication</a><ul>