Skip to content

Commit

Permalink
HTML docs update by Jenkins
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins Automation Server committed Apr 9, 2024
1 parent 04793ce commit ffdd845
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 10 deletions.
4 changes: 2 additions & 2 deletions _modules/opera/pge/cslc_s1/cslc_s1_pge.html
Original file line number Diff line number Diff line change
Expand Up @@ -937,10 +937,10 @@ <h1>Source code for opera.pge.cslc_s1.cslc_s1_pge</h1><div class="highlight"><pr
<span class="n">LEVEL</span> <span class="o">=</span> <span class="s2">&quot;L2&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Processing Level for CSLC-S1 Products&quot;&quot;&quot;</span>

<span class="n">PGE_VERSION</span> <span class="o">=</span> <span class="s2">&quot;2.1.0&quot;</span>
<span class="n">PGE_VERSION</span> <span class="o">=</span> <span class="s2">&quot;2.1.1&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Version of the PGE (overrides default from base_pge)&quot;&quot;&quot;</span>

<span class="n">SAS_VERSION</span> <span class="o">=</span> <span class="s2">&quot;0.5.4&quot;</span> <span class="c1"># Final release https://github.com/opera-adt/COMPASS/releases/tag/v0.5.4</span>
<span class="n">SAS_VERSION</span> <span class="o">=</span> <span class="s2">&quot;0.5.5&quot;</span> <span class="c1"># Final release https://github.com/opera-adt/COMPASS/releases/tag/v0.5.5</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Version of the SAS wrapped by this PGE, should be updated as needed&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pge_name</span><span class="p">,</span> <span class="n">runconfig_path</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
Expand Down
1 change: 0 additions & 1 deletion _modules/opera/util/run_utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,6 @@ <h1>Source code for opera.util.run_utils</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="n">execute_via_shell</span><span class="p">:</span>
<span class="n">command_line</span> <span class="o">=</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command_line</span><span class="p">)</span>

<span class="c1"># TODO: support for timeout argument?</span>
<span class="n">run_result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">command_line</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">copy</span><span class="p">(),</span> <span class="n">check</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">,</span>
<span class="n">shell</span><span class="o">=</span><span class="n">execute_via_shell</span><span class="p">)</span>
Expand Down
2 changes: 0 additions & 2 deletions _modules/opera/util/time.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,6 @@ <h1>Source code for opera.util.time</h1><div class="highlight"><pre>
<span class="sd"> resolution.</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># TODO: Rework to support 0.1 nanosecond resolution</span>
<span class="c1"># That probably means ditching Python&#39;s datetime class.</span>
<span class="n">datetime_str</span> <span class="o">=</span> <span class="n">date_time</span><span class="o">.</span><span class="n">isoformat</span><span class="p">(</span><span class="n">sep</span><span class="o">=</span><span class="s1">&#39;T&#39;</span><span class="p">,</span> <span class="n">timespec</span><span class="o">=</span><span class="s1">&#39;microseconds&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;0000&quot;</span> <span class="o">+</span> <span class="s2">&quot;Z&quot;</span>

<span class="k">return</span> <span class="n">datetime_str</span></div>
Expand Down
4 changes: 2 additions & 2 deletions opera.pge.base.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ <h3>runconfig.py<a class="headerlink" href="#runconfig-py" title="Permalink to t
</section>
<dl class="py data">
<dt class="sig sig-object py" id="opera.pge.base.runconfig.BASE_PGE_SCHEMA">
<span class="sig-prename descclassname"><span class="pre">opera.pge.base.runconfig.</span></span><span class="sig-name descname"><span class="pre">BASE_PGE_SCHEMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/var/lib/jenkins/workspace/se-pipeline_release_3.0.0-rc.2.0/src/opera/pge/base/schema/base_pge_schema.yaml'</span></em><a class="headerlink" href="#opera.pge.base.runconfig.BASE_PGE_SCHEMA" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">opera.pge.base.runconfig.</span></span><span class="sig-name descname"><span class="pre">BASE_PGE_SCHEMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/var/lib/jenkins/workspace/se-pipeline_release_3.0.0-rc.2.1/src/opera/pge/base/schema/base_pge_schema.yaml'</span></em><a class="headerlink" href="#opera.pge.base.runconfig.BASE_PGE_SCHEMA" title="Permalink to this definition"></a></dt>
<dd><p>Path to the Yamale schema applicable to the PGE portion of each RunConfig</p>
</dd></dl>

Expand Down Expand Up @@ -521,7 +521,7 @@ <h3>runconfig.py<a class="headerlink" href="#runconfig-py" title="Permalink to t

<dl class="py method">
<dt class="sig sig-object py" id="opera.pge.base.runconfig.RunConfig.validate">
<span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pge_schema_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/var/lib/jenkins/workspace/se-pipeline_release_3.0.0-rc.2.0/src/opera/pge/base/schema/base_pge_schema.yaml'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/opera/pge/base/runconfig.html#RunConfig.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#opera.pge.base.runconfig.RunConfig.validate" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pge_schema_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/var/lib/jenkins/workspace/se-pipeline_release_3.0.0-rc.2.1/src/opera/pge/base/schema/base_pge_schema.yaml'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/opera/pge/base/runconfig.html#RunConfig.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#opera.pge.base.runconfig.RunConfig.validate" title="Permalink to this definition"></a></dt>
<dd><p>Validates the RunConfig using a combination of the base PGE schema,
and the specific SAS schema defined by the RunConfig itself.</p>
<dl class="field-list simple">
Expand Down
4 changes: 2 additions & 2 deletions opera.pge.cslc_s1.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,13 @@ <h3>cslc_s1_pge.py<a class="headerlink" href="#cslc-s1-pge-py" title="Permalink

<dl class="py attribute">
<dt class="sig sig-object py" id="opera.pge.cslc_s1.cslc_s1_pge.CslcS1Executor.PGE_VERSION">
<span class="sig-name descname"><span class="pre">PGE_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'2.1.0'</span></em><a class="headerlink" href="#opera.pge.cslc_s1.cslc_s1_pge.CslcS1Executor.PGE_VERSION" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">PGE_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'2.1.1'</span></em><a class="headerlink" href="#opera.pge.cslc_s1.cslc_s1_pge.CslcS1Executor.PGE_VERSION" title="Permalink to this definition"></a></dt>
<dd><p>Version of the PGE (overrides default from base_pge)</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="opera.pge.cslc_s1.cslc_s1_pge.CslcS1Executor.SAS_VERSION">
<span class="sig-name descname"><span class="pre">SAS_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'0.5.4'</span></em><a class="headerlink" href="#opera.pge.cslc_s1.cslc_s1_pge.CslcS1Executor.SAS_VERSION" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">SAS_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'0.5.5'</span></em><a class="headerlink" href="#opera.pge.cslc_s1.cslc_s1_pge.CslcS1Executor.SAS_VERSION" title="Permalink to this definition"></a></dt>
<dd><p>Version of the SAS wrapped by this PGE, should be updated as needed</p>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit ffdd845

Please sign in to comment.