Skip to content

Commit

Permalink
[skip ci] Update latest
Browse files Browse the repository at this point in the history
  • Loading branch information
Azure Pipelines committed Feb 6, 2024
1 parent 2d5269b commit b66da1d
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 14 deletions.
10 changes: 9 additions & 1 deletion latest/_modules/mpas_analysis/sea_ice/time_series.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -691,10 +691,13 @@ <h1>Source code for mpas_analysis.sea_ice.time_series</h1><div class="highlight"
<span class="sd"> indices to process.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">config</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span>
<span class="n">chunkYears</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">getint</span><span class="p">(</span><span class="s1">&#39;timeSeriesSeaIceAreaVol&#39;</span><span class="p">,</span> <span class="s1">&#39;chunkYears&#39;</span><span class="p">)</span>

<span class="n">outFileNames</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">hemisphere</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;NH&#39;</span><span class="p">,</span> <span class="s1">&#39;SH&#39;</span><span class="p">]:</span>
<span class="n">baseDirectory</span> <span class="o">=</span> <span class="n">build_config_full_path</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="s1">&#39;output&#39;</span><span class="p">,</span> <span class="s1">&#39;timeSeriesSubdirectory&#39;</span><span class="p">)</span>
<span class="n">config</span><span class="p">,</span> <span class="s1">&#39;output&#39;</span><span class="p">,</span> <span class="s1">&#39;timeSeriesSubdirectory&#39;</span><span class="p">)</span>

<span class="n">make_directories</span><span class="p">(</span><span class="n">baseDirectory</span><span class="p">)</span>

Expand All @@ -713,6 +716,11 @@ <h1>Source code for mpas_analysis.sea_ice.time_series</h1><div class="highlight"
<span class="n">startDate</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">startDate</span><span class="p">,</span>
<span class="n">endDate</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">endDate</span><span class="p">)</span>

<span class="n">nTime</span> <span class="o">=</span> <span class="n">ds</span><span class="o">.</span><span class="n">sizes</span><span class="p">[</span><span class="s1">&#39;Time&#39;</span><span class="p">]</span>
<span class="c1"># chunk into 10-year seguments so we don&#39;t run out of memory</span>
<span class="k">if</span> <span class="n">nTime</span> <span class="o">&gt;</span> <span class="mi">12</span> <span class="o">*</span> <span class="n">chunkYears</span><span class="p">:</span>
<span class="n">ds</span> <span class="o">=</span> <span class="n">ds</span><span class="o">.</span><span class="n">chunk</span><span class="p">({</span><span class="s1">&#39;Time&#39;</span><span class="p">:</span> <span class="mi">12</span> <span class="o">*</span> <span class="n">chunkYears</span><span class="p">})</span>

<span class="k">for</span> <span class="n">hemisphere</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;NH&#39;</span><span class="p">,</span> <span class="s1">&#39;SH&#39;</span><span class="p">]:</span>

<span class="k">if</span> <span class="n">hemisphere</span> <span class="o">==</span> <span class="s1">&#39;NH&#39;</span><span class="p">:</span>
Expand Down
2 changes: 1 addition & 1 deletion ...analysis.shared.climatology.RemapMpasClimatologySubtask.customize_masked_climatology.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ <h1>mpas_analysis.shared.climatology.RemapMpasClimatologySubtask.customize_maske
<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>climatology</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.1.dev0)"><em>xarray.Dataset</em></a>) – The MPAS climatology data set that has had a mask added but has
<li><p><strong>climatology</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – The MPAS climatology data set that has had a mask added but has
not yet been remapped</p></li>
<li><p><strong>season</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The name of the season to be masked</p></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion ...alysis.shared.climatology.RemapMpasClimatologySubtask.customize_remapped_climatology.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h1>mpas_analysis.shared.climatology.RemapMpasClimatologySubtask.customize_remap
<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>climatology</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.1.dev0)"><em>xarray.Dataset</em></a>) – The MPAS climatology data set that has been remapped</p></li>
<li><p><strong>climatology</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a>) – The MPAS climatology data set that has been remapped</p></li>
<li><p><strong>comparisonGridNames</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The name of the comparison grid to use for remapping.</p></li>
<li><p><strong>season</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The name of the season to be remapped</p></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion latest/developers_guide/generated/mpas_analysis.shared.climatology.compute_climatology.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h1>mpas_analysis.shared.climatology.compute_climatology<a class="headerlink" hr
<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>ds</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.1.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a>) – A data set with a <code class="docutils literal notranslate"><span class="pre">Time</span></code> coordinate expressed as days since
<li><p><strong>ds</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a>) – A data set with a <code class="docutils literal notranslate"><span class="pre">Time</span></code> coordinate expressed as days since
0001-01-01 or <code class="docutils literal notranslate"><span class="pre">month</span></code> coordinate</p></li>
<li><p><strong>monthValues</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em> or </em><em>array-like</em><em> of </em><em>ints</em>) – A single month or an array of months to be averaged together</p></li>
<li><p><strong>calendar</strong> (<em>{'gregorian'</em><em>, </em><em>'noleap'}</em><em>, </em><em>optional</em>) – The name of one of the calendars supported by MPAS cores, used to
Expand Down
2 changes: 1 addition & 1 deletion ...elopers_guide/generated/mpas_analysis.shared.climatology.compute_monthly_climatology.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h1>mpas_analysis.shared.climatology.compute_monthly_climatology<a class="header
<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>ds</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.1.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a>) – A data set with a <code class="docutils literal notranslate"><span class="pre">Time</span></code> coordinate expressed as days since
<li><p><strong>ds</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.1.2.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a>) – A data set with a <code class="docutils literal notranslate"><span class="pre">Time</span></code> coordinate expressed as days since
0001-01-01 or <code class="docutils literal notranslate"><span class="pre">month</span></code> coordinate</p></li>
<li><p><strong>calendar</strong> (<em>{'gregorian'</em><em>, </em><em>'noleap'}</em><em>, </em><em>optional</em>) – The name of one of the calendars supported by MPAS cores, used to
determine <code class="docutils literal notranslate"><span class="pre">month</span></code> from <code class="docutils literal notranslate"><span class="pre">Time</span></code> coordinate, so must be supplied if
Expand Down
6 changes: 3 additions & 3 deletions latest/developers_guide/generated/mpas_analysis.shared.plot.plot_vertical_section.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,21 +149,21 @@ <h1>mpas_analysis.shared.plot.plot_vertical_section<a class="headerlink" href="#
<dd class="field-odd"><ul class="simple">
<li><p><strong>config</strong> (<em>instance</em><em> of </em><em>ConfigParser</em>) – the configuration, containing a [plot] section with options that
control plotting</p></li>
<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 v2024.1.1.dev0)"><em>xarray.DataArray</em></a>) – field array to plot. For contour plots, <code class="docutils literal notranslate"><span class="pre">xCoords</span></code> and <code class="docutils literal notranslate"><span class="pre">zCoords</span></code>
<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 v2024.1.2.dev0)"><em>xarray.DataArray</em></a>) – field array to plot. For contour plots, <code class="docutils literal notranslate"><span class="pre">xCoords</span></code> and <code class="docutils literal notranslate"><span class="pre">zCoords</span></code>
should broadcast to the same shape as <code class="docutils literal notranslate"><span class="pre">field</span></code>. For heatmap plots,
<code class="docutils literal notranslate"><span class="pre">xCoords</span></code> and <code class="docutils literal notranslate"><span class="pre">zCoords</span></code> are the corners of the plot. If they
broadcast to the same shape as <code class="docutils literal notranslate"><span class="pre">field</span></code>, <code class="docutils literal notranslate"><span class="pre">field</span></code> will be bilinearly
interpolated to center values for each plot cell. If the coordinates
have one extra element in each direction than <code class="docutils literal notranslate"><span class="pre">field</span></code>, <code class="docutils literal notranslate"><span class="pre">field</span></code> is
assumed to contain cell values and no interpolation is performed.</p></li>
<li><p><strong>colorMapSectionName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – section name in <code class="docutils literal notranslate"><span class="pre">config</span></code> where color map info can be found.</p></li>
<li><p><strong>xCoords</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The x coordinate(s) for the <code class="docutils literal notranslate"><span class="pre">field</span></code>. Optional second
<li><p><strong>xCoords</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The x coordinate(s) for the <code class="docutils literal notranslate"><span class="pre">field</span></code>. Optional second
and third entries will be used for a second and third x axis above the
plot. The typical use for the second and third axis is for transects,
for which the primary x axis represents distance along a transect, and
the second and third x axes are used to display the corresponding
latitudes and longitudes.</p></li>
<li><p><strong>zCoord</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The z coordinates for the <code class="docutils literal notranslate"><span class="pre">field</span></code></p></li>
<li><p><strong>zCoord</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The z coordinates for the <code class="docutils literal notranslate"><span class="pre">field</span></code></p></li>
<li><p><strong>triangulation_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>, </em><em>optional</em>) – A dict of arguments to create a matplotlib.tri.Triangulation of the
transect that does not rely on it being on a logically rectangular grid.
The arguments rather than the triangulation itself are passed because
Expand Down
8 changes: 4 additions & 4 deletions ...evelopers_guide/generated/mpas_analysis.shared.plot.plot_vertical_section_comparison.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,16 +149,16 @@ <h1>mpas_analysis.shared.plot.plot_vertical_section_comparison<a class="headerli
<dd class="field-odd"><ul class="simple">
<li><p><strong>config</strong> (<em>instance</em><em> of </em><em>ConfigParser</em>) – the configuration, containing a [plot] section with options that
control plotting</p></li>
<li><p><strong>modelArray</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a>) – model and observational or control run data sets</p></li>
<li><p><strong>refArray</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a>) – model and observational or control run data sets</p></li>
<li><p><strong>modelArray</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a>) – model and observational or control run data sets</p></li>
<li><p><strong>refArray</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a>) – model and observational or control run data sets</p></li>
<li><p><strong>diffArray</strong> (<em>float array</em>) – difference between modelArray and refArray</p></li>
<li><p><strong>xCoords</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The x coordinate(s) for the model, ref and diff arrays. Optional second
<li><p><strong>xCoords</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The x coordinate(s) for the model, ref and diff arrays. Optional second
and third entries will be used for a second and third x axis above the
plot. The typical use for the second and third axis is for transects,
for which the primary x axis represents distance along a transect, and
the second and third x axes are used to display the corresponding
latitudes and longitudes.</p></li>
<li><p><strong>zCoord</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.1.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The z coordinates for the model, ref and diff arrays</p></li>
<li><p><strong>zCoord</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.1.2.dev0)"><em>xarray.DataArray</em></a><em>, </em><em>optional</em>) – The z coordinates for the model, ref and diff arrays</p></li>
<li><p><strong>triangulation_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>, </em><em>optional</em>) – A dict of arguments to create a matplotlib.tri.Triangulation of the
transect that does not rely on it being on a logically rectangular grid.
The arguments rather than the triangulation itself are passed because
Expand Down
Loading

0 comments on commit b66da1d

Please sign in to comment.