Update documentation

MPAS-Dev · Jan 28, 2025 · d54c914 · d54c914
1 parent 21f729d
commit d54c914
Show file tree

Hide file tree

Showing 2,547 changed files with 382,064 additions and 0 deletions.
diff --git a/1.6.0/_images/LE_hydro.png b/1.6.0/_images/LE_hydro.png
diff --git a/1.6.0/_images/LE_nonhydro.png b/1.6.0/_images/LE_nonhydro.png
diff --git a/1.6.0/_images/M2_plot.png b/1.6.0/_images/M2_plot.png
diff --git a/1.6.0/_images/antarctica_8to80km.png b/1.6.0/_images/antarctica_8to80km.png
diff --git a/1.6.0/_images/atl20km.png b/1.6.0/_images/atl20km.png
diff --git a/1.6.0/_images/atl20km_culled_paraview.png b/1.6.0/_images/atl20km_culled_paraview.png
diff --git a/1.6.0/_images/baroclinic_channel.png b/1.6.0/_images/baroclinic_channel.png
diff --git a/1.6.0/_images/baroclinic_gyre_config.png b/1.6.0/_images/baroclinic_gyre_config.png
diff --git a/1.6.0/_images/buttermilk_bay_standard_points.png b/1.6.0/_images/buttermilk_bay_standard_points.png
diff --git a/1.6.0/_images/buttermilk_bay_standard_solution_169.png b/1.6.0/_images/buttermilk_bay_standard_solution_169.png
diff --git a/1.6.0/_images/buttermilk_bay_subgrid_points.png b/1.6.0/_images/buttermilk_bay_subgrid_points.png
diff --git a/1.6.0/_images/buttermilk_bay_subgrid_solution_169.png b/1.6.0/_images/buttermilk_bay_subgrid_solution_169.png
diff --git a/1.6.0/_images/calving_dt_comparison.png b/1.6.0/_images/calving_dt_comparison.png
diff --git a/1.6.0/_images/circ_shelf_velos.png b/1.6.0/_images/circ_shelf_velos.png
diff --git a/1.6.0/_images/circ_shelf_xsect.png b/1.6.0/_images/circ_shelf_xsect.png
diff --git a/1.6.0/_images/cosine_bell_convergence.png b/1.6.0/_images/cosine_bell_convergence.png
diff --git a/1.6.0/_images/crane_500mto1km.png b/1.6.0/_images/crane_500mto1km.png
diff --git a/1.6.0/_images/dam_break_validation.png b/1.6.0/_images/dam_break_validation.png
diff --git a/1.6.0/_images/drying_slope_forcing.png b/1.6.0/_images/drying_slope_forcing.png
diff --git a/1.6.0/_images/drying_slope_validation.png b/1.6.0/_images/drying_slope_validation.png
diff --git a/1.6.0/_images/ec30to60.png b/1.6.0/_images/ec30to60.png
diff --git a/1.6.0/_images/ec30to601.png b/1.6.0/_images/ec30to601.png
diff --git a/1.6.0/_images/ec30to60_culled_paraview.png b/1.6.0/_images/ec30to60_culled_paraview.png
diff --git a/1.6.0/_images/ecwisc30to60.png b/1.6.0/_images/ecwisc30to60.png
diff --git a/1.6.0/_images/enthalpy_benchmark_A.png b/1.6.0/_images/enthalpy_benchmark_A.png
diff --git a/1.6.0/_images/geojson_io_amazon_delta.png b/1.6.0/_images/geojson_io_amazon_delta.png
diff --git a/1.6.0/_images/geojson_io_south_atl.png b/1.6.0/_images/geojson_io_south_atl.png
diff --git a/1.6.0/_images/gis_speed.png b/1.6.0/_images/gis_speed.png
diff --git a/1.6.0/_images/gotm_eqns.png b/1.6.0/_images/gotm_eqns.png
diff --git a/1.6.0/_images/gotm_vel.png b/1.6.0/_images/gotm_vel.png
diff --git a/1.6.0/_images/gotm_visc.png b/1.6.0/_images/gotm_visc.png
diff --git a/1.6.0/_images/halfar.png b/1.6.0/_images/halfar.png
diff --git a/1.6.0/_images/haney.png b/1.6.0/_images/haney.png
diff --git a/1.6.0/_images/horizontal_advection_convergence.png b/1.6.0/_images/horizontal_advection_convergence.png
diff --git a/1.6.0/_images/humboldt_1to10km.png b/1.6.0/_images/humboldt_1to10km.png
diff --git a/1.6.0/_images/hydro_radial_vs_exact.png b/1.6.0/_images/hydro_radial_vs_exact.png
diff --git a/1.6.0/_images/ice_shelf_2d.png b/1.6.0/_images/ice_shelf_2d.png
diff --git a/1.6.0/_images/internal_wave.png b/1.6.0/_images/internal_wave.png
diff --git a/1.6.0/_images/isomip_plus.png b/1.6.0/_images/isomip_plus.png
diff --git a/1.6.0/_images/isunnguata_sermia_1to10km.png b/1.6.0/_images/isunnguata_sermia_1to10km.png
diff --git a/1.6.0/_images/kangerlussuaq_1to10km.png b/1.6.0/_images/kangerlussuaq_1to10km.png
diff --git a/1.6.0/_images/koge_bugt_s_500m_to_4km.png b/1.6.0/_images/koge_bugt_s_500m_to_4km.png
diff --git a/1.6.0/_images/kuroshio8to60.png b/1.6.0/_images/kuroshio8to60.png
diff --git a/1.6.0/_images/merry-go-round_convergence.png b/1.6.0/_images/merry-go-round_convergence.png
diff --git a/1.6.0/_images/merry-go-round_section.png b/1.6.0/_images/merry-go-round_section.png
diff --git a/1.6.0/_images/ocean.jpg b/1.6.0/_images/ocean.jpg
diff --git a/1.6.0/_images/org_in_package.png b/1.6.0/_images/org_in_package.png
diff --git a/1.6.0/_images/org_in_work_dir.png b/1.6.0/_images/org_in_work_dir.png
diff --git a/1.6.0/_images/overflow.png b/1.6.0/_images/overflow.png
diff --git a/1.6.0/_images/overflow_nonhydro.png b/1.6.0/_images/overflow_nonhydro.png
diff --git a/1.6.0/_images/parabolic_bowl_error.png b/1.6.0/_images/parabolic_bowl_error.png
diff --git a/1.6.0/_images/parabolic_bowl_points.png b/1.6.0/_images/parabolic_bowl_points.png
diff --git a/1.6.0/_images/parabolic_bowl_solution_000.png b/1.6.0/_images/parabolic_bowl_solution_000.png
diff --git a/1.6.0/_images/parabolic_bowl_solution_360.png b/1.6.0/_images/parabolic_bowl_solution_360.png
diff --git a/1.6.0/_images/parabolic_bowl_subgrid_error.png b/1.6.0/_images/parabolic_bowl_subgrid_error.png
diff --git a/1.6.0/_images/parabolic_bowl_subgrid_points.png b/1.6.0/_images/parabolic_bowl_subgrid_points.png
diff --git a/1.6.0/_images/parabolic_bowl_subgrid_solution_360.png b/1.6.0/_images/parabolic_bowl_subgrid_solution_360.png
diff --git a/1.6.0/_images/qu240.png b/1.6.0/_images/qu240.png
diff --git a/1.6.0/_images/qu60.png b/1.6.0/_images/qu60.png
diff --git a/1.6.0/_images/qu60_base_paraview.png b/1.6.0/_images/qu60_base_paraview.png
diff --git a/1.6.0/_images/qu60_culled_paraview.png b/1.6.0/_images/qu60_culled_paraview.png
diff --git a/1.6.0/_images/rrs6to18_temp.png b/1.6.0/_images/rrs6to18_temp.png
diff --git a/1.6.0/_images/simulation_norm_vel_mag.png b/1.6.0/_images/simulation_norm_vel_mag.png
diff --git a/1.6.0/_images/simulation_sst.png b/1.6.0/_images/simulation_sst.png
diff --git a/1.6.0/_images/soma.png b/1.6.0/_images/soma.png
diff --git a/1.6.0/_images/soma_temp.png b/1.6.0/_images/soma_temp.png
diff --git a/1.6.0/_images/sowisc12to60.png b/1.6.0/_images/sowisc12to60.png
diff --git a/1.6.0/_images/sphere_transport.png b/1.6.0/_images/sphere_transport.png
diff --git a/1.6.0/_images/spherical_harmonic_transform_convergence.png b/1.6.0/_images/spherical_harmonic_transform_convergence.png
diff --git a/1.6.0/_images/spherical_harmonic_transform_qu_function.png b/1.6.0/_images/spherical_harmonic_transform_qu_function.png
diff --git a/1.6.0/_images/thwaites_speed.png b/1.6.0/_images/thwaites_speed.png
diff --git a/1.6.0/_images/wc14.png b/1.6.0/_images/wc14.png
diff --git a/1.6.0/_images/yam10to60.png b/1.6.0/_images/yam10to60.png
diff --git a/1.6.0/_images/yam10to60_culled_paraview.png b/1.6.0/_images/yam10to60_culled_paraview.png
diff --git a/1.6.0/_images/ziso.png b/1.6.0/_images/ziso.png
diff --git a/1.6.0/_images/ziso_frazil.png b/1.6.0/_images/ziso_frazil.png
diff --git a/1.6.0/_modules/compass/__main__.html b/1.6.0/_modules/compass/__main__.html
@@ -0,0 +1,209 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>compass.__main__ &mdash; compass 1.6.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
+      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
+
+
+      <script src="../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../index.html" class="icon icon-home">
+            compass
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </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">User's guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../users_guide/quick_start.html">Quick Start for Users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../users_guide/test_cases.html">Test Cases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../users_guide/config_files.html">Config Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../users_guide/test_suites.html">Test Suites</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../users_guide/landice/index.html">Landice core</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../users_guide/ocean/index.html">Ocean core</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../users_guide/machines/index.html">Machines</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Developer's guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/quick_start.html">Quick Start for Developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/overview.html">Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/command_line.html">Command-line interface</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/organization.html">Organization of Tests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/landice/index.html">Landice core</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/ocean/index.html">Ocean core</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/framework.html">Framework</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/machines/index.html">Machines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/troubleshooting.html">Troubleshooting</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/docs.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/building_docs.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/deploying_spack.html">Deploying a new spack environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../developers_guide/api.html">API reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../design_docs/index.html">Design Documents</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorials/dev_add_test_group.html">Developer Tutorial: Adding a new test group</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorials/dev_add_rrm.html">Developer Tutorial: Adding a new ocean/sea ice regionally refined mesh (RRM)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorials/dev_add_param_study.html">Developer Tutorial: Adding a parameter study</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorials/dev_porting_legacy.html">Developer Tutorial: Porting a legacy COMPASS test group</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Glossary</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Versions</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../versions.html">Code and Documentation Versions</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../index.html">compass</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <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"><a href="../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">compass.__main__</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for compass.__main__</h1><div class="highlight"><pre>
+<span></span><span class="ch">#!/usr/bin/env python</span>
+
+<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">argparse</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
+
+<span class="kn">from</span><span class="w"> </span><span class="nn">compass</span><span class="w"> </span><span class="kn">import</span> <span class="nb">list</span><span class="p">,</span> <span class="n">setup</span><span class="p">,</span> <span class="n">clean</span><span class="p">,</span> <span class="n">suite</span><span class="p">,</span> <span class="n">cache</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">compass.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">__version__</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">compass.run.serial</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">run_serial</span>
+
+
+<div class="viewcode-block" id="main">
+<a class="viewcode-back" href="../../developers_guide/generated/compass.__main__.main.html#compass.__main__.main">[docs]</a>
+<span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Entry point for the main script ``compass``</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span>
+        <span class="n">description</span><span class="o">=</span><span class="s2">&quot;Perform compass operations&quot;</span><span class="p">,</span>
+        <span class="n">usage</span><span class="o">=</span><span class="s1">&#39;&#39;&#39;</span>
+<span class="s1">compass &lt;command&gt; [&lt;args&gt;]</span>
+
+<span class="s1">The available compass commands are:</span>
+<span class="s1">    list    List the available test cases</span>
+<span class="s1">    setup   Set up a test case</span>
+<span class="s1">    clean   Clean up a test case</span>
+<span class="s1">    suite   Manage a regression test suite</span>
+<span class="s1">    run     Run a suite, test case or step</span>
+
+<span class="s1"> To get help on an individual command, run:</span>
+
+<span class="s1">    compass &lt;command&gt; --help</span>
+<span class="s1">    &#39;&#39;&#39;</span><span class="p">)</span>
+
+    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;command&#39;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s1">&#39;command to run&#39;</span><span class="p">)</span>
+    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-v&#39;</span><span class="p">,</span> <span class="s1">&#39;--version&#39;</span><span class="p">,</span>
+                        <span class="n">action</span><span class="o">=</span><span class="s1">&#39;version&#39;</span><span class="p">,</span>
+                        <span class="n">version</span><span class="o">=</span><span class="sa">f</span><span class="s1">&#39;compass </span><span class="si">{</span><span class="n">__version__</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
+                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Show version number and exit&quot;</span><span class="p">)</span>
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+        <span class="n">parser</span><span class="o">.</span><span class="n">print_help</span><span class="p">()</span>
+        <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+
+    <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="mi">2</span><span class="p">])</span>
+
+    <span class="c1"># only allow the &quot;compass cache&quot; command if we&#39;re on Anvil or Chrysalis</span>
+    <span class="n">allow_cache</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;COMPASS_MACHINE&#39;</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span> <span class="ow">and</span>
+                   <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;COMPASS_MACHINE&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;anvil&#39;</span><span class="p">,</span> <span class="s1">&#39;chrysalis&#39;</span><span class="p">])</span>
+
+    <span class="n">commands</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;list&#39;</span><span class="p">:</span> <span class="nb">list</span><span class="o">.</span><span class="n">main</span><span class="p">,</span>
+                <span class="s1">&#39;setup&#39;</span><span class="p">:</span> <span class="n">setup</span><span class="o">.</span><span class="n">main</span><span class="p">,</span>
+                <span class="s1">&#39;clean&#39;</span><span class="p">:</span> <span class="n">clean</span><span class="o">.</span><span class="n">main</span><span class="p">,</span>
+                <span class="s1">&#39;suite&#39;</span><span class="p">:</span> <span class="n">suite</span><span class="o">.</span><span class="n">main</span><span class="p">,</span>
+                <span class="s1">&#39;run&#39;</span><span class="p">:</span> <span class="n">run_serial</span><span class="o">.</span><span class="n">main</span><span class="p">}</span>
+    <span class="k">if</span> <span class="n">allow_cache</span><span class="p">:</span>
+        <span class="n">commands</span><span class="p">[</span><span class="s1">&#39;cache&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">main</span>
+
+    <span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">command</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">commands</span><span class="p">:</span>
+        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Unrecognized command </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">command</span><span class="p">))</span>
+        <span class="n">parser</span><span class="o">.</span><span class="n">print_help</span><span class="p">()</span>
+        <span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+
+    <span class="c1"># call the function associated with the requested command</span>
+    <span class="n">commands</span><span class="p">[</span><span class="n">args</span><span class="o">.</span><span class="n">command</span><span class="p">]()</span></div>
+
+
+
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
+    <span class="n">main</span><span class="p">()</span>
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright Copyright (c) 2013-2021,  Los Alamos National Security, LLC (LANS) (Ocean: LA-CC-13-047;Land Ice: LA-CC-13-117) and the University Corporation for Atmospheric Research (UCAR)..</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>