Skip to content

Commit

Permalink
Publish ESMPy Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 16, 2025
1 parent 2bea8a2 commit 6455068
Show file tree
Hide file tree
Showing 47 changed files with 1,063 additions and 1,023 deletions.
Binary file modified docs/nightly/DWesl-patch-1/ESMPy.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/nightly/DWesl-patch-1/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2eb1352daae6c162ef3e8651ba88bb23
tags: 645f666f9bcd5a90fca523b33c5a78b7
42 changes: 21 additions & 21 deletions docs/nightly/DWesl-patch-1/html/CoordSys.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="./">
<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" />
<title>CoordSys &#8212; ESMPy 8.9.0b1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=2bf1fcf8" />

<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>
<script src="_static/documentation_options.js?v=e089b230"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></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">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -33,7 +33,7 @@ <h3>Navigation</h3>
<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-0"><a href="index.html">ESMPy 8.9.0b1 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>
Expand All @@ -45,17 +45,17 @@ <h3>Navigation</h3>
<div class="body" role="main">

<section id="coordsys">
<h1>CoordSys<a class="headerlink" href="#coordsys" title="Permalink to this heading"></a></h1>
<h1>CoordSys<a class="headerlink" href="#coordsys" title="Link 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>
<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="Link 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>
<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="Link 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
Expand All @@ -64,7 +64,7 @@ <h1>CoordSys<a class="headerlink" href="#coordsys" title="Permalink to this head

<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>
<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="Link 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
Expand All @@ -73,7 +73,7 @@ <h1>CoordSys<a class="headerlink" href="#coordsys" title="Permalink to this head

<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>
<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="Link 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
Expand All @@ -89,7 +89,7 @@ <h1>CoordSys<a class="headerlink" href="#coordsys" title="Permalink to this head
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -123,21 +123,21 @@ <h3>This Page</h3>
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<search 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>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -152,14 +152,14 @@ <h3>Navigation</h3>
<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-0"><a href="index.html">ESMPy 8.9.0b1 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.
&#169; Copyright 2011-2025, 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> 8.1.3.
</div>
</body>
</html>
Loading

0 comments on commit 6455068

Please sign in to comment.