Merge pull request #14 from NREL/bnb/py_upgrade

remove py 3.7 add 3.10 and 3.11
NREL · Jul 5, 2024 · 6a4e2e3 · 6a4e2e3
commit 6a4e2e3
Show file tree

Hide file tree

Showing 80 changed files with 9,772 additions and 0 deletions.
diff --git a/.buildinfo b/.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: ce73ab2de3e075e32c3245c5dac8cc3c
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_farms/farms.disc.disc.html b/_farms/farms.disc.disc.html
@@ -0,0 +1,178 @@
+<!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" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>farms.disc.disc &mdash; farms 1.0.6 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <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=e2a723ec"></script>
+        <script src="../_static/doctools.js?v=9a2dae69"></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" />
+    <link rel="next" title="farms.farms_dni" href="farms.farms_dni.html" />
+    <link rel="prev" title="farms.disc" href="farms.disc.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">
+            farms
+          </a>
+              <div class="version">
+                1.0.6
+              </div>
+<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">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="farms.html">farms</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="farms.disc.html">farms.disc</a><ul class="current">
+<li class="toctree-l3 current"><a class="current reference internal" href="#">farms.disc.disc</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#farms.disc.disc"><code class="docutils literal notranslate"><span class="pre">disc()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="farms.farms_dni.html">farms.farms_dni</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.Pice.html">farms.farms_dni.Pice</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.Pice.html#farms.farms_dni.Pice"><code class="docutils literal notranslate"><span class="pre">Pice()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.Pwater.html">farms.farms_dni.Pwater</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.Pwater.html#farms.farms_dni.Pwater"><code class="docutils literal notranslate"><span class="pre">Pwater()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.TDD2.html">farms.farms_dni.TDD2</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.TDD2.html#farms.farms_dni.TDD2"><code class="docutils literal notranslate"><span class="pre">TDD2()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.TDDP.html">farms.farms_dni.TDDP</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.TDDP.html#farms.farms_dni.TDDP"><code class="docutils literal notranslate"><span class="pre">TDDP()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.farms_dni.html">farms.farms_dni.farms_dni</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.farms_dni.html#farms.farms_dni.farms_dni"><code class="docutils literal notranslate"><span class="pre">farms_dni()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="farms.version.html">farms.version</a></li>
+</ul>
+</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">farms</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="farms.html">farms</a></li>
+          <li class="breadcrumb-item"><a href="farms.disc.html">farms.disc</a></li>
+      <li class="breadcrumb-item active">farms.disc.disc</li>
+      <li class="wy-breadcrumbs-aside">
+              <a href="https://github.com/nrel/farms/blob/main/docs/source/_farms/farms.disc.disc.rst" class="fa fa-github"> Edit on GitHub</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="farms-disc-disc">
+<h1>farms.disc.disc<a class="headerlink" href="#farms-disc-disc" title="Link to this heading"></a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="farms.disc.disc">
+<span class="sig-prename descclassname"><span class="pre">farms.disc.</span></span><span class="sig-name descname"><span class="pre">disc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ghi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sza</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pressure</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1013.25</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sza_lim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">87</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/farms/disc.html#disc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#farms.disc.disc" title="Link to this definition"></a></dt>
+<dd><p>Estimate DNI from GHI using the DISC model.</p>
+<p><a href="#id1"><span class="problematic" id="id2">*</span></a>Warning: should only be used for cloudy FARMS data.</p>
+<p>The DISC algorithm converts global horizontal irradiance to direct
+normal irradiance through empirical relationships between the global
+and direct clearness indices.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>ghi</strong> (<em>np.ndarray</em>) – Global horizontal irradiance in W/m2.</p></li>
+<li><p><strong>sza</strong> (<em>np.ndarray</em>) – Solar zenith angle in degrees.</p></li>
+<li><p><strong>doy</strong> (<em>np.ndarray</em>) – Day of year (array of integers).</p></li>
+<li><p><strong>pressure</strong> (<em>np.ndarray</em>) – Pressure in mbar (same as hPa).</p></li>
+<li><p><strong>sza_lim</strong> (<em>float | int</em>) – Upper limit for solar zenith angle in degrees. SZA values greater than
+this will be truncated at this value. 87 deg chosen to simulate the
+FORTRAN code in use by SRRL (from Perez).</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>DNI</strong> (<em>np.ndarray</em>) – Estimated direct normal irradiance in W/m2.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="farms.disc.html" class="btn btn-neutral float-left" title="farms.disc" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="farms.farms_dni.html" class="btn btn-neutral float-right" title="farms.farms_dni" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2020, Alliance for Sustainable Energy, LLC.</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>
diff --git a/_farms/farms.disc.html b/_farms/farms.disc.html
@@ -0,0 +1,171 @@
+<!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" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>farms.disc &mdash; farms 1.0.6 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <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=e2a723ec"></script>
+        <script src="../_static/doctools.js?v=9a2dae69"></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" />
+    <link rel="next" title="farms.disc.disc" href="farms.disc.disc.html" />
+    <link rel="prev" title="farms" href="farms.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">
+            farms
+          </a>
+              <div class="version">
+                1.0.6
+              </div>
+<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">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="farms.html">farms</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="#">farms.disc</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="farms.disc.disc.html">farms.disc.disc</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.disc.disc.html#farms.disc.disc"><code class="docutils literal notranslate"><span class="pre">disc()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="farms.farms_dni.html">farms.farms_dni</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.Pice.html">farms.farms_dni.Pice</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.Pice.html#farms.farms_dni.Pice"><code class="docutils literal notranslate"><span class="pre">Pice()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.Pwater.html">farms.farms_dni.Pwater</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.Pwater.html#farms.farms_dni.Pwater"><code class="docutils literal notranslate"><span class="pre">Pwater()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.TDD2.html">farms.farms_dni.TDD2</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.TDD2.html#farms.farms_dni.TDD2"><code class="docutils literal notranslate"><span class="pre">TDD2()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.TDDP.html">farms.farms_dni.TDDP</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.TDDP.html#farms.farms_dni.TDDP"><code class="docutils literal notranslate"><span class="pre">TDDP()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="farms.farms_dni.farms_dni.html">farms.farms_dni.farms_dni</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="farms.farms_dni.farms_dni.html#farms.farms_dni.farms_dni"><code class="docutils literal notranslate"><span class="pre">farms_dni()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="farms.version.html">farms.version</a></li>
+</ul>
+</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">farms</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="farms.html">farms</a></li>
+      <li class="breadcrumb-item active">farms.disc</li>
+      <li class="wy-breadcrumbs-aside">
+              <a href="https://github.com/nrel/farms/blob/main/docs/source/_farms/farms.disc.rst" class="fa fa-github"> Edit on GitHub</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="module-farms.disc">
+<span id="farms-disc"></span><h1>farms.disc<a class="headerlink" href="#module-farms.disc" title="Link to this heading"></a></h1>
+<p>Created on Wed Jun 25 13:26:21 2014</p>
+<p>&#64;author: alopez, aweekley</p>
+<p>These are functions adapted from PVL_Python.
+There were four main changes from the original code</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li><p>functions were vectorized</p></li>
+<li><p>pvl_ephemeris expects UTC time</p></li>
+<li><p>removed unused result calculations</p></li>
+<li><p>Water and Pressure were changed to vectors from scalers</p></li>
+</ol>
+</div></blockquote>
+<p class="rubric">Functions</p>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="../farms/farms.disc.html#farms.disc.disc" title="farms.disc.disc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disc</span></code></a>(ghi, sza, doy[, pressure, sza_lim])</p></td>
+<td><p>Estimate DNI from GHI using the DISC model.</p></td>
+</tr>
+</tbody>
+</table>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="farms.html" class="btn btn-neutral float-left" title="farms" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="farms.disc.disc.html" class="btn btn-neutral float-right" title="farms.disc.disc" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2020, Alliance for Sustainable Energy, LLC.</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>