deploy: c5fd700

ESMCI · Aug 22, 2024 · e50677c · e50677c
1 parent 8c444f8
commit e50677c
Show file tree

Hide file tree

Showing 11 changed files with 1,733 additions and 15 deletions.
diff --git a/branch/update-mvk-config/html/CIME_api/CIME.SystemTests.html b/branch/update-mvk-config/html/CIME_api/CIME.SystemTests.html
@@ -478,8 +478,74 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 </dd></dl>
 
 </section>
-<section id="cime-systemtests-mvk-module">
-<h2>CIME.SystemTests.mvk module<a class="headerlink" href="#cime-systemtests-mvk-module" title="Link to this heading"></a></h2>
+<section id="module-CIME.SystemTests.mvk">
+<span id="cime-systemtests-mvk-module"></span><h2>CIME.SystemTests.mvk module<a class="headerlink" href="#module-CIME.SystemTests.mvk" title="Link to this heading"></a></h2>
+<p>Multivariate test for climate reproducibility using the Kolmogrov-Smirnov (K-S)
+test and based on The CESM/E3SM model’s multi-instance capability is used to
+conduct an ensemble of simulations starting from different initial conditions.</p>
+<p>This class inherits from SystemTestsCommon.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="CIME.SystemTests.mvk.MVK">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">CIME.SystemTests.mvk.</span></span><span class="sig-name descname"><span class="pre">MVK</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">case</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVK"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVK" title="Link to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="#CIME.SystemTests.system_tests_common.SystemTestsCommon" title="CIME.SystemTests.system_tests_common.SystemTestsCommon"><code class="xref py py-class docutils literal notranslate"><span class="pre">SystemTestsCommon</span></code></a></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="CIME.SystemTests.mvk.MVK.build_phase">
+<span class="sig-name descname"><span class="pre">build_phase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sharedlib_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVK.build_phase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVK.build_phase" title="Link to this definition"></a></dt>
+<dd><p>This is the default build phase implementation, it just does an individual build.
+This is the subclass’ extension point if they need to define a custom build
+phase.</p>
+<p>PLEASE THROW EXCEPTION ON FAIL</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="CIME.SystemTests.mvk.MVK.process_evv_output">
+<span class="sig-name descname"><span class="pre">process_evv_output</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">evv_out_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVK.process_evv_output"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVK.process_evv_output" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="CIME.SystemTests.mvk.MVK.update_testlog">
+<span class="sig-name descname"><span class="pre">update_testlog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">test_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evv_out_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVK.update_testlog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVK.update_testlog" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="CIME.SystemTests.mvk.MVKConfig">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">CIME.SystemTests.mvk.</span></span><span class="sig-name descname"><span class="pre">MVKConfig</span></span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVKConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVKConfig" title="Link to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="CIME.html#CIME.config.ConfigBase" title="CIME.config.ConfigBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigBase</span></code></a></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="CIME.SystemTests.mvk.MVKConfig.evv_test_config">
+<span class="sig-name descname"><span class="pre">evv_test_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">case</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVKConfig.evv_test_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVKConfig.evv_test_config" title="Link to this definition"></a></dt>
+<dd><p>Customize the evv4esm configuration.</p>
+<p>This method is used to customize the default evv4esm configuration
+or generate a completely new one.</p>
+<p>The return configuration will be written to <cite>$RUNDIR/$CASE.json</cite>.</p>
+<dl class="simple">
+<dt>Args:</dt><dd><p>case (CIME.case.case.Case): The case instance.
+config (dict): Default evv4esm configuration.</p>
+</dd>
+<dt>Returns:</dt><dd><p>dict: Dictionary with test configuration.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="CIME.SystemTests.mvk.MVKConfig.generate_namelist">
+<span class="sig-name descname"><span class="pre">generate_namelist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">case</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVKConfig.generate_namelist"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVKConfig.generate_namelist" title="Link to this definition"></a></dt>
+<dd><p>Generate per instance namelist.</p>
+<p>This method is called for each instance to generate the desired
+modifications.</p>
+<dl class="simple">
+<dt>Args:</dt><dd><p>case (CIME.case.case.Case): The case instance.
+component (str): Component the namelist belongs to.
+i (int): Instance unique number.
+filename (str): Name of the namelist that needs to be created.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
 </section>
 <section id="module-CIME.SystemTests.nck">
 <span id="cime-systemtests-nck-module"></span><h2>CIME.SystemTests.nck module<a class="headerlink" href="#module-CIME.SystemTests.nck" title="Link to this heading"></a></h2>

diff --git a/branch/update-mvk-config/html/CIME_api/CIME.html b/branch/update-mvk-config/html/CIME_api/CIME.html
@@ -610,7 +610,20 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l3"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mcc.MCC"><code class="docutils literal notranslate"><span class="pre">MCC</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="CIME.SystemTests.html#cime-systemtests-mvk-module">CIME.SystemTests.mvk module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="CIME.SystemTests.html#module-CIME.SystemTests.mvk">CIME.SystemTests.mvk module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mvk.MVK"><code class="docutils literal notranslate"><span class="pre">MVK</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mvk.MVK.build_phase"><code class="docutils literal notranslate"><span class="pre">MVK.build_phase()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mvk.MVK.process_evv_output"><code class="docutils literal notranslate"><span class="pre">MVK.process_evv_output()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mvk.MVK.update_testlog"><code class="docutils literal notranslate"><span class="pre">MVK.update_testlog()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mvk.MVKConfig"><code class="docutils literal notranslate"><span class="pre">MVKConfig</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mvk.MVKConfig.evv_test_config"><code class="docutils literal notranslate"><span class="pre">MVKConfig.evv_test_config()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.mvk.MVKConfig.generate_namelist"><code class="docutils literal notranslate"><span class="pre">MVKConfig.generate_namelist()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.SystemTests.html#module-CIME.SystemTests.nck">CIME.SystemTests.nck module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="CIME.SystemTests.html#CIME.SystemTests.nck.NCK"><code class="docutils literal notranslate"><span class="pre">NCK</span></code></a></li>
 </ul>
@@ -2110,7 +2123,29 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l3"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests.create_mock_case"><code class="docutils literal notranslate"><span class="pre">create_mock_case()</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-system-tests-mvk-module">CIME.tests.test_unit_system_tests_mvk module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#module-CIME.tests.test_unit_system_tests_mvk">CIME.tests.test_unit_system_tests_mvk module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.tearDown"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.tearDown()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test__compare_baseline"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test__compare_baseline()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test__compare_baseline_resubmit"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test__compare_baseline_resubmit()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test__generate_baseline"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test__generate_baseline()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_build_phase"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_build_phase()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_compare_baseline"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_compare_baseline()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_generate_namelist"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_generate_namelist()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_generate_namelist_multiple_components"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_generate_namelist_multiple_components()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_mvk"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_mvk()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_testmod_complex"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_testmod_complex()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_testmod_simple"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_testmod_simple()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_update_testlog"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_update_testlog()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_update_testlog_htmlroot"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_update_testlog_htmlroot()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_update_testlog_urlroot_None"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_update_testlog_urlroot_None()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.create_complex_case"><code class="docutils literal notranslate"><span class="pre">create_complex_case()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.create_simple_case"><code class="docutils literal notranslate"><span class="pre">create_simple_case()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.write_evv_output"><code class="docutils literal notranslate"><span class="pre">write_evv_output()</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#module-CIME.tests.test_unit_test_status">CIME.tests.test_unit_test_status module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_test_status.TestTestStatus"><code class="docutils literal notranslate"><span class="pre">TestTestStatus</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_test_status.TestTestStatus.setUp"><code class="docutils literal notranslate"><span class="pre">TestTestStatus.setUp()</span></code></a></li>