Skip to content

Commit

Permalink
deploy: e331311
Browse files Browse the repository at this point in the history
  • Loading branch information
@patrickscholz
patrickscholz committed Nov 13, 2024
1 parent d890734 commit 3c5134b
Show file tree
Hide file tree
Showing 8 changed files with 811 additions and 6 deletions.
3 changes: 2 additions & 1 deletion _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
<div class="body" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="tripyview/sub_data.html">tripyview.sub_data</a></li>
<ul><li><a href="tripyview/sub_colormap.html">tripyview.sub_colormap</a></li>
<li><a href="tripyview/sub_data.html">tripyview.sub_data</a></li>
<li><a href="tripyview/sub_dmoc.html">tripyview.sub_dmoc</a></li>
<li><a href="tripyview/sub_index.html">tripyview.sub_index</a></li>
<li><a href="tripyview/sub_mesh.html">tripyview.sub_mesh</a></li>
Expand Down
636 changes: 636 additions & 0 deletions _modules/tripyview/sub_colormap.html
View file

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions _sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ Welcome to tripyview's documentation!
:undoc-members:
:show-inheritance:

.. automodule:: tripyview.sub_colormap
:members:
:undoc-members:
:show-inheritance:

Indices and tables
==================

Expand Down
19 changes: 16 additions & 3 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,14 @@ <h2 id="C">C</h2>
</li>
<li><a href="index.html#tripyview.sub_zmoc.calc_zmoc">calc_zmoc() (in module tripyview.sub_zmoc)</a>
</li>
<li><a href="index.html#tripyview.sub_mesh.compute_boundary_edges">compute_boundary_edges() (in module tripyview.sub_mesh)</a>
<li><a href="index.html#tripyview.sub_colormap.categorical_cmap">categorical_cmap() (in module tripyview.sub_colormap)</a>
</li>
<li><a href="index.html#tripyview.sub_colormap.colormap_c2c">colormap_c2c() (in module tripyview.sub_colormap)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#tripyview.sub_mesh.compute_boundary_edges">compute_boundary_edges() (in module tripyview.sub_mesh)</a>
</li>
<li><a href="index.html#tripyview.sub_mesh.mesh_fesom2.compute_e_area">compute_e_area() (tripyview.sub_mesh.mesh_fesom2 method)</a>
</li>
<li><a href="index.html#tripyview.sub_mesh.mesh_fesom2.compute_e_resol">compute_e_resol() (tripyview.sub_mesh.mesh_fesom2 method)</a>
Expand Down Expand Up @@ -253,6 +257,8 @@ <h2 id="M">M</h2>
module

<ul>
<li><a href="index.html#module-tripyview.sub_colormap">tripyview.sub_colormap</a>
</li>
<li><a href="index.html#module-tripyview.sub_data">tripyview.sub_data</a>
</li>
<li><a href="index.html#module-tripyview.sub_dmoc">tripyview.sub_dmoc</a>
Expand Down Expand Up @@ -325,6 +331,13 @@ <h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
tripyview.sub_colormap

<ul>
<li><a href="index.html#module-tripyview.sub_colormap">module</a>
</li>
</ul></li>
<li>
tripyview.sub_data

<ul>
Expand All @@ -345,15 +358,15 @@ <h2 id="T">T</h2>
<li><a href="index.html#module-tripyview.sub_index">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
tripyview.sub_mesh

<ul>
<li><a href="index.html#module-tripyview.sub_mesh">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
tripyview.sub_plot

Expand Down
147 changes: 146 additions & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5313,8 +5313,153 @@ <h2>–&gt;<a class="headerlink" href="#id4" title="Link to this heading">¶</a>
</div></blockquote>
</dd></dl>

</section>
<hr class="docutils" />
<dl class="py function" id="module-tripyview.sub_colormap">
<dt class="sig sig-object py" id="tripyview.sub_colormap.categorical_cmap">
<span class="sig-prename descclassname"><span class="pre">tripyview.sub_colormap.</span></span><span class="sig-name descname"><span class="pre">categorical_cmap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'tab10'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmap2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'nipy_spectral'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">continuous</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">light2dark</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tripyview/sub_colormap.html#categorical_cmap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tripyview.sub_colormap.categorical_cmap" title="Link to this definition"></a></dt>
<dd><dl class="simple">
<dt>–&gt; build a categorical colormap, based on the predefined standard matplotlib</dt><dd><p>colormap e.g. tab10 and split each color into a number subcolors from light
to dark</p>
</dd>
</dl>
<p>Parameters:</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">nc<span class="colon">:</span></dt>
<dd class="field-odd"><p>int, number of colors in colormap</p>
</dd>
<dt class="field-even">nsc<span class="colon">:</span></dt>
<dd class="field-even"><p>int, number of sub-colors in each color</p>
</dd>
<dt class="field-odd">cmap<span class="colon">:</span></dt>
<dd class="field-odd"><p>str, (default=”tab10”) name of matplotlib colormap</p>
</dd>
<dt class="field-even">cmap2<span class="colon">:</span></dt>
<dd class="field-even"><p>str, (default=”nipy_spectral”) replacement colormap when the
number of colors nc exceed the number of colors in the actual colormap</p>
</dd>
<dt class="field-odd">continuous<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, (default=False)</p>
</dd>
<dt class="field-even">light2dark<span class="colon">:</span></dt>
<dd class="field-even"><p>bool, (default=True), True: do subcategorigal color interpolation from
lighttgrey–&gt;color, False: do subcategorigal color interpolation from
color –&gt; darkgrey</p>
</dd>
</dl>
</div></blockquote>
<p>Returns:</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">cmap<span class="colon">:</span></dt>
<dd class="field-odd"><p>matplotlib.colors.ListedColormap computed based on the input
parameters</p>
</dd>
</dl>
</div></blockquote>
<p>#___________________________________________________________________________</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tripyview.sub_colormap.colormap_c2c">
<span class="sig-prename descclassname"><span class="pre">tripyview.sub_colormap.</span></span><span class="sig-name descname"><span class="pre">colormap_c2c</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cref</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cnumb</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cstep</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">do_slog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">do_rescal</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">rescal_ref</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">cmap_arr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tripyview/sub_colormap.html#colormap_c2c"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tripyview.sub_colormap.colormap_c2c" title="Link to this definition"></a></dt>
<dd><dl class="simple">
<dt>–&gt; create reference value centered colormap with distinct colorsteps based </dt><dd><p>on an rgb matrix</p>
</dd>
</dl>
<p>Parameters:</p>
<blockquote>
<div><dl class="field-list">
<dt class="field-odd">cmin<span class="colon">:</span></dt>
<dd class="field-odd"><p>float, value of minimum color</p>
</dd>
<dt class="field-even">cmax<span class="colon">:</span></dt>
<dd class="field-even"><p>float, value of maximum color</p>
</dd>
<dt class="field-odd">cref<span class="colon">:</span></dt>
<dd class="field-odd"><p>float, value of reference color</p>
</dd>
<dt class="field-even">cnumb<span class="colon">:</span></dt>
<dd class="field-even"><p>int, minimum number of colors that should be at least in
the colormap</p>
</dd>
<dt class="field-odd">cname<span class="colon">:</span></dt>
<dd class="field-odd"><p>str, name of colormap —&gt; see colormap definition, this can
be extended by everyone. If you have have nice new colormap
definition, come back to me and lets add it to the default!</p>
<ul class="simple">
<li><p>blue2red, red2blue</p></li>
<li><p>dblue2dred, dred2dblue</p></li>
<li><p>green2orange, orange2green</p></li>
<li><p>grads</p></li>
<li><p>rainbow</p></li>
<li><p>heat</p></li>
<li><p>jet</p></li>
<li><p>jetw (white reference color)</p></li>
<li><p>hsv</p></li>
<li><p>gnuplot</p></li>
<li><p>arc</p></li>
<li><p>wbgyr, rygbw (white, blue, green ,yellow,red)</p></li>
<li><p>odv</p></li>
<li><p>odvw (white reference color)</p></li>
<li><p>wvt</p></li>
<li><p>wvt1</p></li>
<li><p>wvt2</p></li>
<li><p>wvt3</p></li>
<li><p>seaice</p></li>
<li><p>precip</p></li>
<li><p>drought</p></li>
<li><p>ars</p></li>
</ul>
<p>If you put a “_i” behind the color name string, the colormap will
be inverted</p>
</dd>
<dt class="field-even">cstep<span class="colon">:</span></dt>
<dd class="field-even"><p>float, (default=None) provide fixed color step instead of computing it
based on the covered value range and the minimum number of colors</p>
</dd>
<dt class="field-odd">do_slog<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, (default=False) provide colormap for symmetric logarithmic
scaling</p>
</dd>
<dt class="field-even">do_rescal<span class="colon">:</span></dt>
<dd class="field-even"><p>np.array, (default=None) provide np.array with non linear colorstep
values</p>
</dd>
<dt class="field-odd">rescal_ref<span class="colon">:</span></dt>
<dd class="field-odd"><p>float, (default=None) provide the reference value in the non-linear
colorstep array</p>
</dd>
<dt class="field-even">cmap_arr<span class="colon">:</span></dt>
<dd class="field-even"><p>np.array, (default=None) provide a (nc x 3) rgb value colormap
definition array from the outside beside the predefined ones.
nc must be an odd number. The index of np.ceil(nc/2) will represent
the color of the reference value</p>
</dd>
</dl>
<p>Returns:</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">cmap<span class="colon">:</span></dt>
<dd class="field-odd"><p>matplotlib.colors.ListedColormap computed based on the input
parameters</p>
</dd>
</dl>
<dl class="simple">
<dt>:clevel:np.array() with chosen clevel values, needed for contours and </dt><dd><p>colorbar definition</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">cref<span class="colon">:</span></dt>
<dd class="field-odd"><p>float, returns used cref value</p>
</dd>
</dl>
</div></blockquote>
</div></blockquote>
<p>#___________________________________________________________________________</p>
</dd></dl>

</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
5 changes: 5 additions & 0 deletions py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ <h1>Python Module Index</h1>
<td>
<code class="xref">tripyview</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="index.html#module-tripyview.sub_colormap"><code class="xref">tripyview.sub_colormap</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 3c5134b

Please sign in to comment.