ctsm5.3.040: ctsm_pylib docs

versions/master/html/_sources/users_guide/running-single-points/running-single-point-subset-data.rst.txt

@@ -13,7 +13,7 @@ Subset the data
 
 For single-point cases, you need to subset a surface dataset and (optionally) DATM data. The Python script to subset this data can be found in the CTSM repository at ``tools/site_and_regional/subset_data``.
 
-Note that you will need to have a python environment set up that includes the packages ``scipy``, ``xarray``, and ``numpy``. If you have conda or miniconda installed, you can create a conda environment for this and other CTSM python tools using the script ``py_env_create`` at the top level of your CTSM checkout.
+Note that you will need to have a python environment set up that includes the packages ``scipy``, ``xarray``, and ``numpy``. If you have conda or miniconda installed, you can create a conda environment for this and other CTSM python tools using the script ``py_env_create`` at the top level of your CTSM checkout. See :ref:`using-ctsm-pylib` for more information.
 
 To subset surface data and climate forcings (DATM) for a single point, use the command:
 

versions/master/html/_sources/users_guide/using-clm-tools/index.rst.txt

@@ -16,6 +16,7 @@ Using CLM tools
 
    what-are-the-clm-tools.rst
    building-the-clm-tools.rst
+   using-ctsm-pylib.rst
    creating-input-for-surface-dataset-generation.rst
    creating-surface-datasets.rst
    creating-domain-files.rst

versions/master/html/_sources/users_guide/using-clm-tools/using-ctsm-pylib.rst.txt

@@ -0,0 +1,14 @@
+
+.. include:: ../substitutions.rst
+.. _using-ctsm-pylib:
+
+Installing the CTSM Python environment
+======================================
+
+Many of our Python-based tools require non-standard Python modules to be installed. To facilitate this, you can install a CTSM-specific `Conda <https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html>`__ environment with the exact version of everything needed. From the top level of your CTSM checkout, simply do
+
+.. code:: shell
+
+   ./py_env_create
+
+and that script will install the ``ctsm_pylib`` environment for you. If ``ctsm_pylib`` already exists, it will give you options on how to handle that.

versions/master/html/users_guide/index.html

@@ -217,11 +217,12 @@
 <li class="toctree-l2"><a class="reference internal" href="using-clm-tools/what-are-the-clm-tools.html">1.3.1. What are the CLM tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using-clm-tools/building-the-clm-tools.html">1.3.2. Building the CLM tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using-clm-tools/building-the-clm-tools.html#building-the-clm-tools-that-use-the-cime-configure-build-system">1.3.3. Building the CLM tools that use the CIME configure/build system</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/creating-input-for-surface-dataset-generation.html">1.3.4. Creating input for surface dataset generation</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/creating-surface-datasets.html">1.3.5. Creating Surface Datasets</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/creating-domain-files.html">1.3.6. Creating CLM domain files</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/observational-sites-datasets.html">1.3.7. Observational Sites Datasets</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/cprnc.html">1.3.8. Comparing History Files</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/using-ctsm-pylib.html">1.3.4. Installing the CTSM Python environment</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/creating-input-for-surface-dataset-generation.html">1.3.5. Creating input for surface dataset generation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/creating-surface-datasets.html">1.3.6. Creating Surface Datasets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/creating-domain-files.html">1.3.7. Creating CLM domain files</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/observational-sites-datasets.html">1.3.8. Observational Sites Datasets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using-clm-tools/cprnc.html">1.3.9. Comparing History Files</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="adding-new-resolutions/index.html">1.4. Adding New Resolutions</a><ul>
@@ -265,7 +266,7 @@
 </li>
 </ul>
 </div>
-<p>Documentation was built: Mar 27, 2025</p>
+<p>Documentation was built: Apr 15, 2025</p>
 </div>
 
 

versions/master/html/users_guide/overview/introduction.html

@@ -250,7 +250,7 @@
 
 Community Terrestrial Systems Model (CTSM) science version 5.3 series -- source code, tools, 
 offline-build and test scripts. This gives you everything you need
-to run CTSM with CESM with the CMEPS driver and CDEPS data models to provide CRU NCEP or GSWP3 forcing data in 
+to run CTSM with CESM with the CMEPS driver and CDEPS data models to provide CRUJRA or GSWP3 forcing data (some older options also available) in
 place of a modeled atmosphere.
 
 CMEPS is the Community Mediator for Earth Prediction Systems. And CDEPS is the

versions/master/html/users_guide/running-single-points/running-single-point-subset-data.html

@@ -204,7 +204,7 @@
 <div class="section" id="subset-the-data">
 <h2><span class="section-number">1.6.2.1. </span>Subset the data<a class="headerlink" href="#subset-the-data" title="Permalink to this headline">¶</a></h2>
 <p>For single-point cases, you need to subset a surface dataset and (optionally) DATM data. The Python script to subset this data can be found in the CTSM repository at <code class="docutils literal notranslate"><span class="pre">tools/site_and_regional/subset_data</span></code>.</p>
-<p>Note that you will need to have a python environment set up that includes the packages <code class="docutils literal notranslate"><span class="pre">scipy</span></code>, <code class="docutils literal notranslate"><span class="pre">xarray</span></code>, and <code class="docutils literal notranslate"><span class="pre">numpy</span></code>. If you have conda or miniconda installed, you can create a conda environment for this and other CTSM python tools using the script <code class="docutils literal notranslate"><span class="pre">py_env_create</span></code> at the top level of your CTSM checkout.</p>
+<p>Note that you will need to have a python environment set up that includes the packages <code class="docutils literal notranslate"><span class="pre">scipy</span></code>, <code class="docutils literal notranslate"><span class="pre">xarray</span></code>, and <code class="docutils literal notranslate"><span class="pre">numpy</span></code>. If you have conda or miniconda installed, you can create a conda environment for this and other CTSM python tools using the script <code class="docutils literal notranslate"><span class="pre">py_env_create</span></code> at the top level of your CTSM checkout. See <a class="reference internal" href="../using-clm-tools/using-ctsm-pylib.html#using-ctsm-pylib"><span class="std std-ref">Installing the CTSM Python environment</span></a> for more information.</p>
 <p>To subset surface data and climate forcings (DATM) for a single point, use the command:</p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>tools/site_and_regional/subset_data point <span class="se">\</span>
    --lat <span class="nv">$my_lat</span> --lon <span class="nv">$my_lon</span> --site <span class="nv">$my_site_name</span> <span class="se">\</span>

versions/master/html/users_guide/using-clm-tools/cprnc.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>1.3.8. Comparing History Files &mdash; ctsm CTSM master documentation</title>
+  <title>1.3.9. Comparing History Files &mdash; ctsm CTSM master documentation</title>
 
 
 
@@ -40,7 +40,7 @@
     <link rel="top" title="ctsm CTSM master documentation" href="../../index.html"/>
         <link rel="up" title="1.3. Using CLM tools" href="index.html"/>
         <link rel="next" title="1.4. Adding New Resolutions" href="../adding-new-resolutions/index.html"/>
-        <link rel="prev" title="1.3.7. Observational Sites Datasets" href="observational-sites-datasets.html"/> 
+        <link rel="prev" title="1.3.8. Observational Sites Datasets" href="observational-sites-datasets.html"/> 
 
 
   <script src="../../_static/js/modernizr.min.js"></script>
@@ -114,11 +114,12 @@
 <li class="toctree-l3"><a class="reference internal" href="what-are-the-clm-tools.html">1.3.1. What are the CLM tools</a></li>
 <li class="toctree-l3"><a class="reference internal" href="building-the-clm-tools.html">1.3.2. Building the CLM tools</a></li>
 <li class="toctree-l3"><a class="reference internal" href="building-the-clm-tools.html#building-the-clm-tools-that-use-the-cime-configure-build-system">1.3.3. Building the CLM tools that use the CIME configure/build system</a></li>
-<li class="toctree-l3"><a class="reference internal" href="creating-input-for-surface-dataset-generation.html">1.3.4. Creating input for surface dataset generation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="creating-surface-datasets.html">1.3.5. Creating Surface Datasets</a></li>
-<li class="toctree-l3"><a class="reference internal" href="creating-domain-files.html">1.3.6. Creating CLM domain files</a></li>
-<li class="toctree-l3"><a class="reference internal" href="observational-sites-datasets.html">1.3.7. Observational Sites Datasets</a></li>
-<li class="toctree-l3 current"><a class="current reference internal" href="#">1.3.8. Comparing History Files</a></li>
+<li class="toctree-l3"><a class="reference internal" href="using-ctsm-pylib.html">1.3.4. Installing the CTSM Python environment</a></li>
+<li class="toctree-l3"><a class="reference internal" href="creating-input-for-surface-dataset-generation.html">1.3.5. Creating input for surface dataset generation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="creating-surface-datasets.html">1.3.6. Creating Surface Datasets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="creating-domain-files.html">1.3.7. Creating CLM domain files</a></li>
+<li class="toctree-l3"><a class="reference internal" href="observational-sites-datasets.html">1.3.8. Observational Sites Datasets</a></li>
+<li class="toctree-l3 current"><a class="current reference internal" href="#">1.3.9. Comparing History Files</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../adding-new-resolutions/index.html">1.4. Adding New Resolutions</a></li>
@@ -179,7 +180,7 @@
 
           <li><a href="index.html"><span class="section-number">1.3. </span>Using CLM tools</a> &raquo;</li>
 
-      <li><span class="section-number">1.3.8. </span>Comparing History Files</li>
+      <li><span class="section-number">1.3.9. </span>Comparing History Files</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -199,7 +200,7 @@
            <div itemprop="articleBody">
 
   <div class="section" id="comparing-history-files">
-<span id="id1"></span><h1><span class="section-number">1.3.8. </span>Comparing History Files<a class="headerlink" href="#comparing-history-files" title="Permalink to this headline">¶</a></h1>
+<span id="id1"></span><h1><span class="section-number">1.3.9. </span>Comparing History Files<a class="headerlink" href="#comparing-history-files" title="Permalink to this headline">¶</a></h1>
 <p><code class="docutils literal notranslate"><span class="pre">cprnc</span></code> is a tool shared by CESM2.2 beta to compare two NetCDF history files. It differences every field that is shared on both files, and reports a summary of the difference. The summary includes the three largest differences, as well as the root mean square (RMS) difference. It also gives some summary information on the field as well. You have to enter at least one file, and up to two files. With one file it gives you summary information on the file, and with two it gives you information on the differences between the two. At the end it will give you a summary of the fields compared and how many fields were different and how many were identical.</p>
 <p>Options:</p>
 <p>-m = do NOT align time-stamps before comparing</p>
@@ -223,7 +224,7 @@
         <a href="../adding-new-resolutions/index.html" class="btn btn-neutral float-right" title="1.4. Adding New Resolutions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="observational-sites-datasets.html" class="btn btn-neutral" title="1.3.7. Observational Sites Datasets" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="observational-sites-datasets.html" class="btn btn-neutral" title="1.3.8. Observational Sites Datasets" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>