deploy: b3a5424

branch/update-mvk-config/html/CIME_api/CIME.SystemTests.html

@@ -513,30 +513,31 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <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">run_dir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_dir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evv_lib_dir</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>Configure the evv test.</p>
-<p>This method is used to pass the evv4esm configuration to be written for the test.</p>
+<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.
-run_dir (str): Path the case’s run directory.
-base_dir (str): Path to the case’s baseline directory.
-evv_lib_dir (str): Path to the evv4esm package root.</p>
+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.write_inst_nml">
-<span class="sig-name descname"><span class="pre">write_inst_nml</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">set_nml_variable</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">iinst</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/SystemTests/mvk.html#MVKConfig.write_inst_nml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.SystemTests.mvk.MVKConfig.write_inst_nml" title="Link to this definition"></a></dt>
-<dd><p>Write per instance namelist.</p>
-<p>This method is called once per instance to generate the namelist.</p>
+<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.
-write_nml_variable (function): Function takes two <cite>str</cite> arguments.
 component (str): Component the namelist belongs to.
-iinst (int): Instance unique number.</p>
+i (int): Instance unique number.
+filename (str): Name of the namelist that needs to be created.</p>
 </dd>
 </dl>
 </dd></dl>

branch/update-mvk-config/html/CIME_api/CIME.html

@@ -207,6 +207,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#CIME.namelist.Namelist"><code class="docutils literal notranslate"><span class="pre">Namelist</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#CIME.namelist.character_literal_to_string"><code class="docutils literal notranslate"><span class="pre">character_literal_to_string()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#CIME.namelist.compress_literal_list"><code class="docutils literal notranslate"><span class="pre">compress_literal_list()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#CIME.namelist.convert_bool"><code class="docutils literal notranslate"><span class="pre">convert_bool()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#CIME.namelist.expand_literal_list"><code class="docutils literal notranslate"><span class="pre">expand_literal_list()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#CIME.namelist.fortran_namelist_base_value"><code class="docutils literal notranslate"><span class="pre">fortran_namelist_base_value()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#CIME.namelist.get_fortran_name_only"><code class="docutils literal notranslate"><span class="pre">get_fortran_name_only()</span></code></a></li>
@@ -611,7 +612,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 </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.write_inst_nml"><code class="docutils literal notranslate"><span class="pre">MVKConfig.write_inst_nml()</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>
@@ -2137,14 +2138,14 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <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>
-<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK.test_write_inst_nml"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_write_inst_nml()</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_write_inst_nml_multiple_components"><code class="docutils literal notranslate"><span class="pre">TestSystemTestsMVK.test_write_inst_nml_multiple_components()</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>
@@ -2641,7 +2642,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py function">
 <dt class="sig sig-object py" id="CIME.config.print_rst_header">
-<span class="sig-prename descclassname"><span class="pre">CIME.config.</span></span><span class="sig-name descname"><span class="pre">print_rst_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/config.html#print_rst_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.config.print_rst_header" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">CIME.config.</span></span><span class="sig-name descname"><span class="pre">print_rst_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">anchor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'&quot;'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/config.html#print_rst_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.config.print_rst_header" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
@@ -3551,6 +3552,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 </div>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="CIME.namelist.convert_bool">
+<span class="sig-prename descclassname"><span class="pre">CIME.namelist.</span></span><span class="sig-name descname"><span class="pre">convert_bool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/namelist.html#convert_bool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.namelist.convert_bool" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="CIME.namelist.expand_literal_list">
 <span class="sig-prename descclassname"><span class="pre">CIME.namelist.</span></span><span class="sig-name descname"><span class="pre">expand_literal_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">literals</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/CIME/namelist.html#expand_literal_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CIME.namelist.expand_literal_list" title="Link to this definition"></a></dt>
@@ -5041,7 +5047,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 4. default to same value as PROJECT</p>
 <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">CIME</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">CIME.XML.machines</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">machobj</span> <span class="o">=</span> <span class="n">CIME</span><span class="o">.</span><span class="n">XML</span><span class="o">.</span><span class="n">machines</span><span class="o">.</span><span class="n">Machines</span><span class="p">(</span><span class="n">machine</span><span class="o">=</span><span class="s2">&quot;theta&quot;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">machobj</span> <span class="o">=</span> <span class="n">CIME</span><span class="o">.</span><span class="n">XML</span><span class="o">.</span><span class="n">machines</span><span class="o">.</span><span class="n">Machines</span><span class="p">(</span><span class="n">machine</span><span class="o">=</span><span class="s2">&quot;docker&quot;</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">project</span> <span class="o">=</span> <span class="n">get_project</span><span class="p">(</span><span class="n">machobj</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">charge_account</span> <span class="o">=</span> <span class="n">get_charge_account</span><span class="p">(</span><span class="n">machobj</span><span class="p">,</span> <span class="n">project</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">project</span> <span class="o">==</span> <span class="n">charge_account</span>