Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/pycopm.core.pycopm.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
file-generation details are implemented in the utility modules.</p>
<dl class="py function">
<dt class="sig sig-object py" id="pycopm.core.pycopm._check_cmdargs">
<span class="sig-prename descclassname"><span class="pre">pycopm.core.pycopm.</span></span><span class="sig-name descname"><span class="pre">_check_cmdargs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pycopm.core.pycopm._check_cmdargs" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pycopm.core.pycopm.</span></span><span class="sig-name descname"><span class="pre">_check_cmdargs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pycopm.core.pycopm._check_cmdargs" title="Link to this definition"></a></dt>
<dd><p>Validate command-line arguments and incompatible operations.</p>
<p>The checks cover input type, Flow availability, coarsening and refinement
syntax, aggregation methods, vicinity selections, transformations, and
Expand Down Expand Up @@ -140,7 +140,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="pycopm.core.pycopm._parse_arguments">
<span class="sig-prename descclassname"><span class="pre">pycopm.core.pycopm.</span></span><span class="sig-name descname"><span class="pre">_parse_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pycopm.core.pycopm._parse_arguments" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pycopm.core.pycopm.</span></span><span class="sig-name descname"><span class="pre">_parse_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Namespace</span></span></span><a class="headerlink" href="#pycopm.core.pycopm._parse_arguments" title="Link to this definition"></a></dt>
<dd><p>Parse supported command-line arguments.</p>
<p>Unknown arguments are left unprocessed for compatibility with external
launchers.</p>
Expand All @@ -159,7 +159,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="pycopm.core.pycopm.main">
<span class="sig-prename descclassname"><span class="pre">pycopm.core.pycopm.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pycopm.core.pycopm.main" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pycopm.core.pycopm.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pycopm.core.pycopm.main" title="Link to this definition"></a></dt>
<dd><p>Run the deck-based or TOML-based pycopm workflow.</p>
<p>OPM <code class="docutils literal notranslate"><span class="pre">.DATA</span></code> decks can be coarsened, refined, transformed, or reduced to
a submodel. TOML configurations generate coarsened Norne or Drogon cases
Expand Down
2 changes: 1 addition & 1 deletion docs/pycopm.utils.coarsening.html
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="pycopm.utils.coarsening.create_coarsening_maps">
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.coarsening.</span></span><span class="sig-name descname"><span class="pre">create_coarsening_maps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dck</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ConfigViaDeck</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdargs</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 internal" href="#pycopm.utils.coarsening.CoarseningMaps" title="pycopm.utils.coarsening.CoarseningMaps"><span class="pre">CoarseningMaps</span></a></span></span><a class="headerlink" href="#pycopm.utils.coarsening.create_coarsening_maps" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.coarsening.</span></span><span class="sig-name descname"><span class="pre">create_coarsening_maps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dck</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ConfigViaDeck</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</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 internal" href="#pycopm.utils.coarsening.CoarseningMaps" title="pycopm.utils.coarsening.CoarseningMaps"><span class="pre">CoarseningMaps</span></a></span></span><a class="headerlink" href="#pycopm.utils.coarsening.create_coarsening_maps" title="Link to this definition"></a></dt>
<dd><p>Create axis mappings and assign original cells to coarse cells.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/pycopm.utils.generate_decks.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="pycopm.utils.generate_decks.create_deck">
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.generate_decks.</span></span><span class="sig-name descname"><span class="pre">create_deck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dck</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ConfigViaDeck</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pycopm.utils.generate_decks.create_deck" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.generate_decks.</span></span><span class="sig-name descname"><span class="pre">create_deck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dck</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ConfigViaDeck</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pycopm.utils.generate_decks.create_deck" title="Link to this definition"></a></dt>
<dd><p>Generate a modified OPM deck and its include files.</p>
<p>The selected workflow can preprocess the input deck, coarsen or refine the
grid, extract a vicinity submodel, transform coordinates, and optionally run
Expand Down
2 changes: 1 addition & 1 deletion docs/pycopm.utils.input_values.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
<p>Create configuration objects from command-line arguments and TOML files.</p>
<dl class="py function">
<dt class="sig sig-object py" id="pycopm.utils.input_values.create_deck_config">
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.input_values.</span></span><span class="sig-name descname"><span class="pre">create_deck_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ConfigViaDeck</span></span></span><a class="headerlink" href="#pycopm.utils.input_values.create_deck_config" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.input_values.</span></span><span class="sig-name descname"><span class="pre">create_deck_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ConfigViaDeck</span></span></span><a class="headerlink" href="#pycopm.utils.input_values.create_deck_config" title="Link to this definition"></a></dt>
<dd><p>Create a deck configuration from parsed command arguments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/pycopm.utils.refinement.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="pycopm.utils.refinement.create_refinement_maps">
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.refinement.</span></span><span class="sig-name descname"><span class="pre">create_refinement_maps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dck</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ConfigViaDeck</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdargs</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 internal" href="#pycopm.utils.refinement.RefinementMaps" title="pycopm.utils.refinement.RefinementMaps"><span class="pre">RefinementMaps</span></a></span></span><a class="headerlink" href="#pycopm.utils.refinement.create_refinement_maps" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pycopm.utils.refinement.</span></span><span class="sig-name descname"><span class="pre">create_refinement_maps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dck</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ConfigViaDeck</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</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 internal" href="#pycopm.utils.refinement.RefinementMaps" title="pycopm.utils.refinement.RefinementMaps"><span class="pre">RefinementMaps</span></a></span></span><a class="headerlink" href="#pycopm.utils.refinement.create_refinement_maps" title="Link to this definition"></a></dt>
<dd><p>Create axis refinement maps and update output dimensions.</p>
<p>A refinement value of <code class="docutils literal notranslate"><span class="pre">n</span></code> divides an original interval into <code class="docutils literal notranslate"><span class="pre">n</span> <span class="pre">+</span> <span class="pre">1</span></code>
intervals.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

Loading