deploy: e0ec6b5

_sources/cesm.rst.txt

@@ -1,4 +1,4 @@
-python API
+Python API
 ===========
 
 .. automodule:: cesm

_sources/container/1_intro_container.md.txt

@@ -48,5 +48,5 @@ make -j && make install
 ```
 
 ### [Python for urban climate exploration](5_python_API.md)
-We apply some Python codes to help run a case of CLM to explore urban climate. 
+We apply some Python code to help run a case of CLM to explore urban climate. 
 

_sources/container/intro.rst.txt

@@ -37,5 +37,5 @@ Running CMLU within CLM (Community Land Model) requires a Linux operation system
 
 Python for urban climate exploration
 ------------------------------------
-We apply some Python codes to help run a case of CLM to explore urban climate. 
+We apply some Python code to help run a case of CLM to explore urban climate. 
 

_sources/container/run_container.md.txt

@@ -74,7 +74,7 @@ export CSMDATA=/p/scratch/CESMDATAROOT/inputdata
 export CASESCRIPT=/p/project/myclm/cime/scripts
 ```
 
-#### Tips for docker commander
+#### Tips for docker commands
 - docker ps: check for the running container
 - docker stop <container-id>: stop the container
 - docker start <container-id>: start the container

_sources/index.rst.txt

@@ -3,28 +3,24 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-CLMU APP
+CLMU-App
 ==================================
 
-|docs| |GitHub| |license|
-
-.. |docs| image:: https://readthedocs.org/projects/urbanclimateexplorer/badge/?version=latest
-   :target: https://urbanclimateexplorer.readthedocs.io/en/latest/?badge=latest
-   :alt: Documentation Status
+|GitHub| |license|
 
 .. |GitHub| image:: https://img.shields.io/badge/GitHub-clmu--app-brightgreen.svg
    :target: https://github.com/envdes/clmu-app
 
 .. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
    :target: https://github.com/envdes/clmu-app/blob/main/LICENSE
 
-Using Python to drive CLMU simulations via container.
+CLMU-App: Enabling Operating System Indenpendent Urban Climate Simulations
 
 Author: `Junjie Yu <https://junjieyu-uom.github.io>`_, `Dr. Zhonghua Zheng <https://zhonghuazheng.com>`_, `Yuan Sun <https://github.com/YuanSun-UoM>`_, `Dr. Keith Oleson <https://staff.ucar.edu/users/oleson>`_
 
 .. toctree::
    :maxdepth: 2
-   :caption: CLMU APP container
+   :caption: CLMU-App container
 
    container/intro.rst
    container/install_docker.rst

cesm.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>python API &mdash; clmu-app v0.0.0 documentation</title>
+  <title>Python API &mdash; clmu-app v0.0.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -44,7 +44,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="container/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="container/install_docker.html">Install Docker</a></li>
@@ -64,7 +64,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">python API</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Python API</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#cesm.cesm_run"><code class="docutils literal notranslate"><span class="pre">cesm_run</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#cesm.cesm_run.create_case"><code class="docutils literal notranslate"><span class="pre">cesm_run.create_case()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#cesm.cesm_run.modify_case_config"><code class="docutils literal notranslate"><span class="pre">cesm_run.modify_case_config()</span></code></a></li>
@@ -97,7 +97,7 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">python API</li>
+      <li class="breadcrumb-item active">Python API</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/cesm.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -108,7 +108,7 @@
            <div itemprop="articleBody">
 
   <section id="module-cesm">
-<span id="python-api"></span><h1>python API<a class="headerlink" href="#module-cesm" title="Permalink to this heading"></a></h1>
+<span id="python-api"></span><h1>Python API<a class="headerlink" href="#module-cesm" title="Permalink to this heading"></a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="cesm.cesm_run">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cesm.</span></span><span class="sig-name descname"><span class="pre">cesm_run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CASESCRIPT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">CASESCRIPT_local</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">CASEROOT_local</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">DOUT_S_ROOT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">JSONPATH</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cesm.cesm_run" title="Permalink to this definition"></a></dt>

container/1_intro_container.html

@@ -43,7 +43,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_docker.html">Install Docker</a></li>
@@ -63,7 +63,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>
@@ -137,7 +137,7 @@ <h2>User notice<a class="headerlink" href="#user-notice" title="Permalink to thi
 </section>
 <section id="python-for-urban-climate-exploration">
 <h2><a class="reference internal" href="5_python_API.html"><span class="doc">Python for urban climate exploration</span></a><a class="headerlink" href="#python-for-urban-climate-exploration" title="Permalink to this heading"></a></h2>
-<p>We apply some Python codes to help run a case of CLM to explore urban climate.</p>
+<p>We apply some Python code to help run a case of CLM to explore urban climate.</p>
 </section>
 </section>
 

container/2_install_docker.html

@@ -43,7 +43,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_docker.html">Install Docker</a></li>
@@ -63,7 +63,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>

container/3_CLMU_env_details.html

@@ -43,7 +43,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_docker.html">Install Docker</a></li>
@@ -63,7 +63,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>

container/4_run_CLM_case.html

@@ -45,7 +45,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_docker.html">Install Docker</a></li>
@@ -68,7 +68,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>

container/5_python_API.html

@@ -45,7 +45,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_docker.html">Install Docker</a></li>
@@ -65,7 +65,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>

container/clmu_env.html

@@ -45,7 +45,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_docker.html">Install Docker</a></li>
@@ -69,7 +69,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>

container/install_docker.html

@@ -45,7 +45,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Install Docker</a><ul>
@@ -69,7 +69,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>

container/intro.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="Install Docker" href="install_docker.html" />
-    <link rel="prev" title="CLMU APP" href="../index.html" /> 
+    <link rel="prev" title="CLMU-App" href="../index.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -45,7 +45,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#id1">What is a container?</a></li>
@@ -71,7 +71,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>
@@ -130,15 +130,15 @@ <h2>Why use a container for CLMU?<a class="headerlink" href="#why-use-a-containe
 </section>
 <section id="python-for-urban-climate-exploration">
 <h2>Python for urban climate exploration<a class="headerlink" href="#python-for-urban-climate-exploration" title="Permalink to this heading"></a></h2>
-<p>We apply some Python codes to help run a case of CLM to explore urban climate.</p>
+<p>We apply some Python code to help run a case of CLM to explore urban climate.</p>
 </section>
 </section>
 
 
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="../index.html" class="btn btn-neutral float-left" title="CLMU APP" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="../index.html" class="btn btn-neutral float-left" title="CLMU-App" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="install_docker.html" class="btn btn-neutral float-right" title="Install Docker" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

container/run_container.html

@@ -45,7 +45,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_docker.html">Install Docker</a></li>
@@ -55,7 +55,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#build-container">Build container</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#install-clm5-0-installed-in-clmu-app">Install CLM5.0 (installed in clmu-app)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#optional-singularity-container-software-for-hpc">Optional: Singularity (Container software for HPC)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#tips-for-docker-commander">Tips for docker commander</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#tips-for-docker-commands">Tips for docker commands</a></li>
 </ul>
 </li>
 </ul>
@@ -75,7 +75,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>
@@ -170,8 +170,8 @@ <h3>Optional: Singularity (Container software for HPC)<a class="headerlink" href
 </pre></div>
 </div>
 </section>
-<section id="tips-for-docker-commander">
-<h3>Tips for docker commander<a class="headerlink" href="#tips-for-docker-commander" title="Permalink to this heading"></a></h3>
+<section id="tips-for-docker-commands">
+<h3>Tips for docker commands<a class="headerlink" href="#tips-for-docker-commands" title="Permalink to this heading"></a></h3>
 <ul class="simple">
 <li><p>docker ps: check for the running container</p></li>
 <li><p>docker stop <container-id>: stop the container</p></li>

examples/Single_point_modeling.html

@@ -48,7 +48,7 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">CLMU APP container</span></p>
+              <p class="caption" role="heading"><span class="caption-text">CLMU-App container</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../container/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../container/install_docker.html">Install Docker</a></li>
@@ -73,7 +73,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../cesm.html">python API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cesm.html">Python API</a></li>
 </ul>
 
         </div>