Publish ESMPy Docs

esmf-org · Oct 31, 2024 · 4dba99b · 4dba99b
1 parent cb93e25
commit 4dba99b
Show file tree

Hide file tree

Showing 79 changed files with 13,676 additions and 0 deletions.
diff --git a/docs/nightly/v8.8.0b03/ESMPy.pdf b/docs/nightly/v8.8.0b03/ESMPy.pdf
diff --git a/docs/nightly/v8.8.0b03/html/.buildinfo b/docs/nightly/v8.8.0b03/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 9a7b71e66bbdff19ccf1e1465780cd5a
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/nightly/v8.8.0b03/html/CoordSys.html b/docs/nightly/v8.8.0b03/html/CoordSys.html
@@ -0,0 +1,165 @@
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>CoordSys &#8212; ESMPy 8.8.0b0 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
+
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=ee9199f9"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
+
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="ExtrapMethod" href="ExtrapMethod.html" />
+    <link rel="prev" title="RegridFromFile" href="regridfromfile.html" /> 
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="ExtrapMethod.html" title="ExtrapMethod"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="regridfromfile.html" title="RegridFromFile"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ESMPy 8.8.0b0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="appendix.html" accesskey="U">Appendices</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">CoordSys</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <section id="coordsys">
+<h1>CoordSys<a class="headerlink" href="#coordsys" title="Permalink to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="esmpy.api.constants.CoordSys">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">esmpy.api.constants.</span></span><span class="sig-name descname"><span class="pre">CoordSys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</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">module</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">type</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">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#esmpy.api.constants.CoordSys" title="Permalink to this definition">¶</a></dt>
+<dd><p>This flag indicates the coordinate system of a <a class="reference internal" href="grid.html#esmpy.api.grid.Grid" title="esmpy.api.grid.Grid"><code class="xref py py-class docutils literal notranslate"><span class="pre">Grid</span></code></a>. This value is
+useful both to indicate to other users the type of the coordinates,
+but also to control how the coordinates are interpreted in
+regridding methods (e.g. <a class="reference internal" href="regrid.html#esmpy.api.regrid.Regrid" title="esmpy.api.regrid.Regrid"><code class="xref py py-class docutils literal notranslate"><span class="pre">Regrid</span></code></a>).</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="esmpy.api.constants.CoordSys.CART">
+<span class="sig-name descname"><span class="pre">CART</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;CoordSys.CART:</span> <span class="pre">0&gt;</span></em><a class="headerlink" href="#esmpy.api.constants.CoordSys.CART" title="Permalink to this definition">¶</a></dt>
+<dd><p>Cartesian coordinate system. In this system, the Cartesian
+coordinates are mapped to the <a class="reference internal" href="grid.html#esmpy.api.grid.Grid" title="esmpy.api.grid.Grid"><code class="xref py py-class docutils literal notranslate"><span class="pre">Grid</span></code></a> coordinate dimensions in the
+following order: x, y, z. (e.g. using coord_dim=1 in
+<a class="reference internal" href="grid.html#esmpy.api.grid.Grid.get_coords" title="esmpy.api.grid.Grid.get_coords"><code class="xref py py-class docutils literal notranslate"><span class="pre">get_coords()</span></code></a> references the y dimension)</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="esmpy.api.constants.CoordSys.SPH_DEG">
+<span class="sig-name descname"><span class="pre">SPH_DEG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;CoordSys.SPH_DEG:</span> <span class="pre">1&gt;</span></em><a class="headerlink" href="#esmpy.api.constants.CoordSys.SPH_DEG" title="Permalink to this definition">¶</a></dt>
+<dd><p>Spherical coordinates in degrees. In this system, the spherical
+coordinates are mapped to the <a class="reference internal" href="grid.html#esmpy.api.grid.Grid" title="esmpy.api.grid.Grid"><code class="xref py py-class docutils literal notranslate"><span class="pre">Grid</span></code></a> coordinate dimensions in the
+following order: longitude, latitude, radius. (E.g. using
+coord_dim=1 in <code class="xref py py-class docutils literal notranslate"><span class="pre">get_coords()`</span></code> references the latitude dimension).</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="esmpy.api.constants.CoordSys.SPH_RAD">
+<span class="sig-name descname"><span class="pre">SPH_RAD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;CoordSys.SPH_RAD:</span> <span class="pre">2&gt;</span></em><a class="headerlink" href="#esmpy.api.constants.CoordSys.SPH_RAD" title="Permalink to this definition">¶</a></dt>
+<dd><p>Spherical coordinates in radians. In this system, the spherical
+coordinates are mapped to the <a class="reference internal" href="grid.html#esmpy.api.grid.Grid" title="esmpy.api.grid.Grid"><code class="xref py py-class docutils literal notranslate"><span class="pre">Grid</span></code></a> coordinate dimensions in the
+following order: longitude, latitude, radius. (E.g. using
+coord_dim=1 in <a class="reference internal" href="grid.html#esmpy.api.grid.Grid.get_coords" title="esmpy.api.grid.Grid.get_coords"><code class="xref py py-class docutils literal notranslate"><span class="pre">get_coords()</span></code></a> references the latitude dimension).</p>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">CoordSys</a><ul>
+<li><a class="reference internal" href="#esmpy.api.constants.CoordSys"><code class="docutils literal notranslate"><span class="pre">CoordSys</span></code></a><ul>
+<li><a class="reference internal" href="#esmpy.api.constants.CoordSys.CART"><code class="docutils literal notranslate"><span class="pre">CoordSys.CART</span></code></a></li>
+<li><a class="reference internal" href="#esmpy.api.constants.CoordSys.SPH_DEG"><code class="docutils literal notranslate"><span class="pre">CoordSys.SPH_DEG</span></code></a></li>
+<li><a class="reference internal" href="#esmpy.api.constants.CoordSys.SPH_RAD"><code class="docutils literal notranslate"><span class="pre">CoordSys.SPH_RAD</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="regridfromfile.html"
+                          title="previous chapter">RegridFromFile</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="ExtrapMethod.html"
+                          title="next chapter">ExtrapMethod</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/CoordSys.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="ExtrapMethod.html" title="ExtrapMethod"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="regridfromfile.html" title="RegridFromFile"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ESMPy 8.8.0b0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="appendix.html" >Appendices</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">CoordSys</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2011-2024, University Corporation for Atmospheric Research, Massachusetts Institute of Technology, Geophysical Fluid Dynamics Laboratory, University of Michigan, National Centers for Environmental Prediction, Los Alamos National Laboratory, Argonne National Laboratory, NASA Goddard Space Flight Center.  Licensed under the University of Illinois-NCSA License.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
+    </div>
+  </body>
+</html>