Skip to content

Commit

Permalink
deploy: 5b65def
Browse files Browse the repository at this point in the history
  • Loading branch information
rafmudaf committed Mar 19, 2024
1 parent 8a77e0a commit bd9df01
Show file tree
Hide file tree
Showing 26 changed files with 177 additions and 3,904 deletions.
2 changes: 1 addition & 1 deletion .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: 724438fc8258c7ea37fb6a37cf731147
config: c49c331cc3bf202d58dda2c63b9dd08a
tags: 645f666f9bcd5a90fca523b33c5a78b7
15 changes: 3 additions & 12 deletions _autosummary/wcomp.base_interface.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,6 @@
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../api_docs.html">API Documentation</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2 current active"><a class="current reference internal" href="#">wcomp.base_interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.floris_interface.html">wcomp.floris_interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.foxes_interface.html">wcomp.foxes_interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.pywake_interface.html">wcomp.pywake_interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.output_struct.html">wcomp.output_struct</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.plotting.html">wcomp.plotting</a></li>
</ul>
Expand Down Expand Up @@ -435,29 +433,22 @@ <h2> Contents </h2>
<p class="rubric">Classes</p>
<table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#wcomp.base_interface.WCompBase" title="wcomp.base_interface.WCompBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WCompBase</span></code></a>(input_file, velocity_deficit, ...)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#wcomp.base_interface.WCompBase" title="wcomp.base_interface.WCompBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WCompBase</span></code></a>(input_file)</p></td>
<td><p>WCompBase is an abstract base class that defines the interfaces required to conform to the <cite>wcomp</cite> framework.</p></td>
</tr>
</tbody>
</table>
<dl class="py class">
<dt class="sig sig-object py" id="wcomp.base_interface.WCompBase">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wcomp.base_interface.</span></span><span class="sig-name descname"><span class="pre">WCompBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">velocity_deficit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">velocity_deficit_p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deflection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deflection_p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaw_angles</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[0.0]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wcomp/base_interface.html#WCompBase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wcomp.base_interface.WCompBase" title="Link 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">wcomp.base_interface.</span></span><span class="sig-name descname"><span class="pre">WCompBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wcomp/base_interface.html#WCompBase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wcomp.base_interface.WCompBase" title="Link to this definition">#</a></dt>
<dd><p>WCompBase is an abstract base class that defines the interfaces required
to conform to the <cite>wcomp</cite> framework. This class cannot be used directly. Instead,
it should be used to create a subclass, and all attributes and functions
described here should be implemented in the subclass. See function docstrings
for implementation details.</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>input_file</strong> (<em>str</em><em> | </em><em>Path</em>) -- </p></li>
<li><p><strong>velocity_deficit</strong> (<em>Any</em>) -- </p></li>
<li><p><strong>velocity_deficit_p</strong> (<em>dict</em>) -- </p></li>
<li><p><strong>deflection</strong> (<em>Any</em>) -- </p></li>
<li><p><strong>deflection_p</strong> (<em>dict</em>) -- </p></li>
<li><p><strong>yaw_angles</strong> (<em>list</em><em>[</em><em>float</em><em>]</em>) -- </p></li>
</ul>
<dd class="field-odd"><p><strong>input_file</strong> (<em>str</em><em> | </em><em>Path</em>) -- </p>
</dd>
</dl>
<dl class="py attribute">
Expand Down
20 changes: 6 additions & 14 deletions _autosummary/wcomp.floris_interface.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = '_autosummary/wcomp.floris_interface';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="wcomp.foxes_interface" href="wcomp.foxes_interface.html" />
<link rel="next" title="wcomp.output_struct" href="wcomp.output_struct.html" />
<link rel="prev" title="wcomp.base_interface" href="wcomp.base_interface.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="python"/>
Expand Down Expand Up @@ -188,8 +188,6 @@
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../api_docs.html">API Documentation</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="wcomp.base_interface.html">wcomp.base_interface</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">wcomp.floris_interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.foxes_interface.html">wcomp.foxes_interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.pywake_interface.html">wcomp.pywake_interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.output_struct.html">wcomp.output_struct</a></li>
<li class="toctree-l2"><a class="reference internal" href="wcomp.plotting.html">wcomp.plotting</a></li>
</ul>
Expand Down Expand Up @@ -437,24 +435,18 @@ <h2> Contents </h2>
<p class="rubric">Classes</p>
<table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#wcomp.floris_interface.WCompFloris" title="wcomp.floris_interface.WCompFloris"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WCompFloris</span></code></a>(input_file, velocity_deficit, ...)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#wcomp.floris_interface.WCompFloris" title="wcomp.floris_interface.WCompFloris"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WCompFloris</span></code></a>(input_file)</p></td>
<td><p><cite>WCompFloris</cite> implements the wcomp interface to the FLORIS software.</p></td>
</tr>
</tbody>
</table>
<dl class="py class">
<dt class="sig sig-object py" id="wcomp.floris_interface.WCompFloris">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wcomp.floris_interface.</span></span><span class="sig-name descname"><span class="pre">WCompFloris</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">velocity_deficit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">velocity_deficit_p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deflection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'none'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deflection_p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaw_angles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.0]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wcomp/floris_interface.html#WCompFloris"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wcomp.floris_interface.WCompFloris" title="Link 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">wcomp.floris_interface.</span></span><span class="sig-name descname"><span class="pre">WCompFloris</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wcomp/floris_interface.html#WCompFloris"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wcomp.floris_interface.WCompFloris" title="Link to this definition">#</a></dt>
<dd><p><cite>WCompFloris</cite> implements the wcomp interface to the FLORIS software.</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>input_file</strong> (<em>str</em><em> | </em><em>Path</em>) -- </p></li>
<li><p><strong>velocity_deficit</strong> (<em>str</em>) -- </p></li>
<li><p><strong>velocity_deficit_p</strong> (<em>dict</em>) -- </p></li>
<li><p><strong>deflection</strong> (<em>str</em>) -- </p></li>
<li><p><strong>deflection_p</strong> (<em>dict</em>) -- </p></li>
</ul>
<dd class="field-odd"><p><strong>input_file</strong> (<em>str</em><em> | </em><em>Path</em>) -- </p>
</dd>
</dl>
<dl class="py attribute">
Expand Down Expand Up @@ -709,11 +701,11 @@ <h2> Contents </h2>
</div>
</a>
<a class="right-next"
href="wcomp.foxes_interface.html"
href="wcomp.output_struct.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">wcomp.foxes_interface</p>
<p class="prev-next-title">wcomp.output_struct</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
Loading

0 comments on commit bd9df01

Please sign in to comment.