deploy: ba6f8c3

versions/master/html/CIME_api/CIME.case.html

@@ -170,9 +170,6 @@ <h2>CIME.case.case_test module<a class="headerlink" href="#cime-case-case-test-m
 <section id="cime-case-check-input-data-module">
 <h2>CIME.case.check_input_data module<a class="headerlink" href="#cime-case-check-input-data-module" title="Link to this heading"></a></h2>
 </section>
-<section id="cime-case-check-lockedfiles-module">
-<h2>CIME.case.check_lockedfiles module<a class="headerlink" href="#cime-case-check-lockedfiles-module" title="Link to this heading"></a></h2>
-</section>
 <section id="cime-case-preview-namelists-module">
 <h2>CIME.case.preview_namelists module<a class="headerlink" href="#cime-case-preview-namelists-module" title="Link to this heading"></a></h2>
 </section>

versions/master/html/CIME_api/CIME.html

@@ -276,7 +276,6 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l2"><a class="reference internal" href="CIME.case.html#cime-case-case-submit-module">CIME.case.case_submit module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.case.html#cime-case-case-test-module">CIME.case.case_test module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.case.html#cime-case-check-input-data-module">CIME.case.check_input_data module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="CIME.case.html#cime-case-check-lockedfiles-module">CIME.case.check_lockedfiles module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.case.html#cime-case-preview-namelists-module">CIME.case.preview_namelists module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.case.html#module-contents">Module contents</a></li>
 </ul>
@@ -369,6 +368,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-expected-fails-file-module">CIME.tests.test_unit_expected_fails_file module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-grids-module">CIME.tests.test_unit_grids module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-hist-utils-module">CIME.tests.test_unit_hist_utils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-locked-files-module">CIME.tests.test_unit_locked_files module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-nmlgen-module">CIME.tests.test_unit_nmlgen module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CIME.tests.html#module-CIME.tests.test_unit_paramgen">CIME.tests.test_unit_paramgen module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="CIME.tests.html#CIME.tests.test_unit_paramgen.DummyCase"><code class="docutils literal notranslate"><span class="pre">DummyCase</span></code></a><ul>

versions/master/html/CIME_api/CIME.tests.html

@@ -381,6 +381,9 @@ <h2>CIME.tests.test_unit_grids module<a class="headerlink" href="#cime-tests-tes
 <section id="cime-tests-test-unit-hist-utils-module">
 <h2>CIME.tests.test_unit_hist_utils module<a class="headerlink" href="#cime-tests-test-unit-hist-utils-module" title="Link to this heading"></a></h2>
 </section>
+<section id="cime-tests-test-unit-locked-files-module">
+<h2>CIME.tests.test_unit_locked_files module<a class="headerlink" href="#cime-tests-test-unit-locked-files-module" title="Link to this heading"></a></h2>
+</section>
 <section id="cime-tests-test-unit-nmlgen-module">
 <h2>CIME.tests.test_unit_nmlgen module<a class="headerlink" href="#cime-tests-test-unit-nmlgen-module" title="Link to this heading"></a></h2>
 </section>

versions/master/html/CIME_api/modules.html

@@ -221,7 +221,6 @@ <h1>CIME<a class="headerlink" href="#cime" title="Link to this heading"></a><
 <li class="toctree-l4"><a class="reference internal" href="CIME.case.html#cime-case-case-submit-module">CIME.case.case_submit module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.case.html#cime-case-case-test-module">CIME.case.case_test module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.case.html#cime-case-check-input-data-module">CIME.case.check_input_data module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="CIME.case.html#cime-case-check-lockedfiles-module">CIME.case.check_lockedfiles module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.case.html#cime-case-preview-namelists-module">CIME.case.preview_namelists module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.case.html#module-contents">Module contents</a></li>
 </ul>
@@ -280,6 +279,7 @@ <h1>CIME<a class="headerlink" href="#cime" title="Link to this heading"></a><
 <li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-expected-fails-file-module">CIME.tests.test_unit_expected_fails_file module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-grids-module">CIME.tests.test_unit_grids module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-hist-utils-module">CIME.tests.test_unit_hist_utils module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-locked-files-module">CIME.tests.test_unit_locked_files module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-nmlgen-module">CIME.tests.test_unit_nmlgen module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#module-CIME.tests.test_unit_paramgen">CIME.tests.test_unit_paramgen module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="CIME.tests.html#cime-tests-test-unit-system-tests-module">CIME.tests.test_unit_system_tests module</a></li>

versions/master/html/_sources/CIME_api/CIME.case.rst.txt

@@ -76,14 +76,6 @@ CIME.case.check\_input\_data module
    :undoc-members:
    :show-inheritance:
 
-CIME.case.check\_lockedfiles module
------------------------------------
-
-.. automodule:: CIME.case.check_lockedfiles
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 CIME.case.preview\_namelists module
 -----------------------------------
 

versions/master/html/_sources/CIME_api/CIME.tests.rst.txt

@@ -300,6 +300,14 @@ CIME.tests.test\_unit\_hist\_utils module
    :undoc-members:
    :show-inheritance:
 
+CIME.tests.test\_unit\_locked\_files module
+-------------------------------------------
+
+.. automodule:: CIME.tests.test_unit_locked_files
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 CIME.tests.test\_unit\_nmlgen module
 ------------------------------------
 

versions/master/html/_sources/users_guide/components.rst.txt

@@ -0,0 +1,62 @@
+.. _components:
+
+==========
+Components
+==========
+
+A single component in the smallest unit within a model. Multiple components make up a component set.
+
+Configuration
+--------------
+
+The configuration for a component can be found under `cime_config` in the component directory.
+
+Example contents of a components `config_component.xml`.
+
+::
+
+   <?xml version="1.0"?>
+
+   <?xml-stylesheet type="text/xsl" href="entry_id.xsl" ?>
+
+   <entry_id version="3.0">
+     <description>
+       <desc atm="SATM">Stub atm component</desc>
+     </description>
+
+     <entry id="COMP_ATM">
+       <type>char</type>
+       <valid_values>satm</valid_values>
+       <default_value>satm</default_value>
+       <group>case_comp</group>
+       <file>env_case.xml</file>
+       <desc>Name of atmosphere component</desc>
+     </entry>
+
+
+     <help>
+       =========================================
+       SATM naming conventions in compset name
+       =========================================
+     </help>
+
+   </entry_id>
+
+Triggering a rebuild
+--------------------
+
+It's the responsibility of a component to define which settings will require a component to be rebuilt.
+
+These triggers can be defined as follows.
+
+::
+
+  <entry id="REBUILD_TRIGGER_ATM">
+    <type>char</type>
+    <default_value>NTASKS,NTHREADS,NINST</default_value>
+    <group>rebuild_triggers</group>
+    <file>env_build.xml</file>
+    <desc>Settings that will trigger a rebuild</desc>
+  </entry>
+
+If a user was to change `NTASKS`, `NTHREADS`, or `NINST` in a case using the component, then a rebuild would be required before the case could be submitted again.

versions/master/html/_sources/users_guide/index.rst.txt

@@ -36,6 +36,7 @@ Configuring the Case Control System
    :numbered:
 
    cime-internals.rst
+   components.rst
    compsets.rst
    grids.rst
    machine.rst

versions/master/html/build_cpl/index.html

@@ -23,7 +23,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="1. Introduction" href="introduction.html" />
-    <link rel="prev" title="10. Directory content" href="../users_guide/cime-dir.html" /> 
+    <link rel="prev" title="11. Directory content" href="../users_guide/cime-dir.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -114,7 +114,7 @@ <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="../users_guide/cime-dir.html" class="btn btn-neutral float-left" title="10. Directory content" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="../users_guide/cime-dir.html" class="btn btn-neutral float-left" title="11. Directory content" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="introduction.html" class="btn btn-neutral float-right" title="1. Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

versions/master/html/index.html

@@ -117,15 +117,16 @@ <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Link
 </li>
 <li class="toctree-l1"><a class="reference internal" href="users_guide/index.html#configuring-the-case-control-system">Configuring the Case Control System</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="users_guide/cime-internals.html">1. Main Configuration File</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/compsets.html">2. Component sets</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/grids.html">3. Model grids</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/machine.html">4. Defining the machine</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/pes-threads.html">5. Controlling processors and threads</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/porting-cime.html">6. Porting and validating CIME on a new platform</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/unit_testing.html">7. Fortran Unit Testing</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/multi-instance.html">8. Multi-instance component functionality</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/workflows.html">9. Workflows</a></li>
-<li class="toctree-l2"><a class="reference internal" href="users_guide/cime-dir.html">10. Directory content</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/components.html">2. Components</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/compsets.html">3. Component sets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/grids.html">4. Model grids</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/machine.html">5. Defining the machine</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/pes-threads.html">6. Controlling processors and threads</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/porting-cime.html">7. Porting and validating CIME on a new platform</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/unit_testing.html">8. Fortran Unit Testing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/multi-instance.html">9. Multi-instance component functionality</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/workflows.html">10. Workflows</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users_guide/cime-dir.html">11. Directory content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="users_guide/index.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>

versions/master/html/users_guide/cime-dir.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>10. Directory content &mdash; CIME master documentation</title>
+  <title>11. Directory content &mdash; CIME master documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../_static/custom.css" />
@@ -23,7 +23,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Building a Coupled Model with CIME" href="../build_cpl/index.html" />
-    <link rel="prev" title="9. Workflows" href="workflows.html" /> 
+    <link rel="prev" title="10. Workflows" href="workflows.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -53,15 +53,16 @@
 <li class="toctree-l1"><a class="reference internal" href="index.html">Using the Case Control System</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="index.html#configuring-the-case-control-system">Configuring the Case Control System</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="cime-internals.html">1. Main Configuration File</a></li>
-<li class="toctree-l2"><a class="reference internal" href="compsets.html">2. Component sets</a></li>
-<li class="toctree-l2"><a class="reference internal" href="grids.html">3. Model grids</a></li>
-<li class="toctree-l2"><a class="reference internal" href="machine.html">4. Defining the machine</a></li>
-<li class="toctree-l2"><a class="reference internal" href="pes-threads.html">5. Controlling processors and threads</a></li>
-<li class="toctree-l2"><a class="reference internal" href="porting-cime.html">6. Porting and validating CIME on a new platform</a></li>
-<li class="toctree-l2"><a class="reference internal" href="unit_testing.html">7. Fortran Unit Testing</a></li>
-<li class="toctree-l2"><a class="reference internal" href="multi-instance.html">8. Multi-instance component functionality</a></li>
-<li class="toctree-l2"><a class="reference internal" href="workflows.html">9. Workflows</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">10. Directory content</a></li>
+<li class="toctree-l2"><a class="reference internal" href="components.html">2. Components</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compsets.html">3. Component sets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="grids.html">4. Model grids</a></li>
+<li class="toctree-l2"><a class="reference internal" href="machine.html">5. Defining the machine</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pes-threads.html">6. Controlling processors and threads</a></li>
+<li class="toctree-l2"><a class="reference internal" href="porting-cime.html">7. Porting and validating CIME on a new platform</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unit_testing.html">8. Fortran Unit Testing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="multi-instance.html">9. Multi-instance component functionality</a></li>
+<li class="toctree-l2"><a class="reference internal" href="workflows.html">10. Workflows</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">11. Directory content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
@@ -91,7 +92,7 @@
   <ul class="wy-breadcrumbs">
       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="index.html">Using the Case Control System</a></li>
-      <li class="breadcrumb-item active"><span class="section-number">10. </span>Directory content</li>
+      <li class="breadcrumb-item active"><span class="section-number">11. </span>Directory content</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/users_guide/cime-dir.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -102,7 +103,7 @@
            <div itemprop="articleBody">
 
   <section id="directory-content">
-<span id="cime-dir"></span><h1><span class="section-number">10. </span>Directory content<a class="headerlink" href="#directory-content" title="Link to this heading"></a></h1>
+<span id="cime-dir"></span><h1><span class="section-number">11. </span>Directory content<a class="headerlink" href="#directory-content" title="Link to this heading"></a></h1>
 <p>If you use CIME as part of a climate model or standalone, the content of the <strong>cime</strong> directory is the same.</p>
 <p>If you are using it as part of a climate model, <strong>cime</strong> is usually one of the first subdirectories under the main directory.</p>
 <table class="docutils align-default" id="id1">
@@ -195,7 +196,7 @@
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="workflows.html" class="btn btn-neutral float-left" title="9. Workflows" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="workflows.html" class="btn btn-neutral float-left" title="10. Workflows" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="../build_cpl/index.html" class="btn btn-neutral float-right" title="Building a Coupled Model with CIME" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>