Skip to content

Commit 449c299

Browse files
Update documentation
1 parent 517423a commit 449c299

File tree

8 files changed

+3
-3
lines changed

8 files changed

+3
-3
lines changed
4.91 KB
Binary file not shown.
4.91 KB
Binary file not shown.
4.91 KB
Binary file not shown.
4.91 KB
Binary file not shown.
4.92 KB
Binary file not shown.

main/.doctrees/environment.pickle

4.91 KB
Binary file not shown.

main/developers_guide/framework/visualization.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,8 @@ <h3>plotting from spherical MPAS meshes<a class="headerlink" href="#plotting-fro
267267
<a class="reference external" href="https://matplotlib.org/stable/gallery/images_contours_and_fields/colormap_normalizations_symlognorm.html">symmetric log</a>
268268
colormap with a central linear region), or <code class="docutils literal notranslate"><span class="pre">log</span></code> (a logarithmic colormap).</p>
269269
<p>The <code class="docutils literal notranslate"><span class="pre">norm_args</span></code> depend on the <code class="docutils literal notranslate"><span class="pre">norm_typ</span></code> and are the arguments to
270-
<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.Normalize.html#matplotlib.colors.Normalize" title="(in Matplotlib v3.10.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.colors.Normalize</span></code></a>, <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.SymLogNorm.html#matplotlib.colors.SymLogNorm" title="(in Matplotlib v3.10.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.colors.SymLogNorm</span></code></a>,
271-
and <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.LogNorm.html#matplotlib.colors.LogNorm" title="(in Matplotlib v3.10.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.colors.LogNorm</span></code></a>, respectively.</p>
270+
<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.Normalize.html#matplotlib.colors.Normalize" title="(in Matplotlib v3.10.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.colors.Normalize</span></code></a>, <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.SymLogNorm.html#matplotlib.colors.SymLogNorm" title="(in Matplotlib v3.10.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.colors.SymLogNorm</span></code></a>,
271+
and <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.LogNorm.html#matplotlib.colors.LogNorm" title="(in Matplotlib v3.10.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.colors.LogNorm</span></code></a>, respectively.</p>
272272
<p>The config option <code class="docutils literal notranslate"><span class="pre">colorbar_ticks</span></code> (if it is defined) specifies tick locations
273273
along the colorbar. If it is not specified, they are determined automatically.</p>
274274
</section>

main/developers_guide/generated/polaris.viz.plot_horiz_field.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ <h1>polaris.viz.plot_horiz_field<a class="headerlink" href="#polaris-viz-plot-ho
155155
<li><p><strong>ds_mesh</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2025.10.1)"><em>xarray.Dataset</em></a>) – A data set containing horizontal mesh variables</p></li>
156156
<li><p><strong>field</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2025.10.1)"><em>xarray.DataArray</em></a>) – The data array to plot</p></li>
157157
<li><p><strong>out_file_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><em>optional</em>) – The path to which the plot image should be written</p></li>
158-
<li><p><strong>ax</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.10.6)"><em>matplotlib.axes.Axes</em></a>) – Axes to plot to if making a multi-panel figure</p></li>
158+
<li><p><strong>ax</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.10.7)"><em>matplotlib.axes.Axes</em></a>) – Axes to plot to if making a multi-panel figure</p></li>
159159
<li><p><strong>title</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><em>optional</em>) – The title of the plot</p></li>
160160
<li><p><strong>vmin</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em>, </em><em>optional</em>) – The minimum values for the colorbar; if provided, must be positive if
161161
<code class="docutils literal notranslate"><span class="pre">cmap_scale</span> <span class="pre">==</span> <span class="pre">'log'</span></code></p></li>

0 commit comments

Comments
 (0)