Skip to content

Commit 517423a

Browse files
Update documentation
1 parent 58896df commit 517423a

File tree

241 files changed

+859
-859
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+859
-859
lines changed
102 KB
Binary file not shown.
102 KB
Binary file not shown.
102 KB
Binary file not shown.
102 KB
Binary file not shown.
102 KB
Binary file not shown.

main/.doctrees/environment.pickle

102 KB
Binary file not shown.

main/developers_guide/e3sm/init/generated/polaris.tasks.e3sm.init.topo.combine.CombineStep.constrain_resources.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h1>polaris.tasks.e3sm.init.topo.combine.CombineStep.constrain_resources<a class
135135
cores available to this step</p>
136136
<dl class="field-list simple">
137137
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
138-
<dd class="field-odd"><p><strong>available_resources</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – The total number of cores available to the step</p>
138+
<dd class="field-odd"><p><strong>available_resources</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – The total number of cores available to the step</p>
139139
</dd>
140140
</dl>
141141
</dd></dl>

main/developers_guide/e3sm/init/generated/polaris.tasks.e3sm.init.topo.combine.CombineStep.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,11 @@ <h1>polaris.tasks.e3sm.init.topo.combine.CombineStep<a class="headerlink" href="
135135
<dl class="field-list simple">
136136
<dt class="field-odd">Variables<span class="colon">:</span></dt>
137137
<dd class="field-odd"><ul class="simple">
138-
<li><p><strong>resolution</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – degrees (float) or face subdivisions (int)</p></li>
139-
<li><p><strong>resolution_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – either x.xxxx_degrees or NExxx</p></li>
140-
<li><p><strong>combined_filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – name of the combined topography file</p></li>
141-
<li><p><strong>dst_scrip_filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – name of the destination SCRIP file</p></li>
142-
<li><p><strong>exodus_filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – name of the exodus file for the cubed sphere mesh</p></li>
138+
<li><p><strong>resolution</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – degrees (float) or face subdivisions (int)</p></li>
139+
<li><p><strong>resolution_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>) – either x.xxxx_degrees or NExxx</p></li>
140+
<li><p><strong>combined_filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – name of the combined topography file</p></li>
141+
<li><p><strong>dst_scrip_filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – name of the destination SCRIP file</p></li>
142+
<li><p><strong>exodus_filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – name of the exodus file for the cubed sphere mesh</p></li>
143143
</ul>
144144
</dd>
145145
</dl>
@@ -151,8 +151,8 @@ <h1>polaris.tasks.e3sm.init.topo.combine.CombineStep<a class="headerlink" href="
151151
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
152152
<dd class="field-odd"><ul class="simple">
153153
<li><p><strong>component</strong> (<a class="reference internal" href="../../../generated/polaris.Component.html#polaris.Component" title="polaris.Component"><em>polaris.Component</em></a>) – The component the step belongs to</p></li>
154-
<li><p><strong>subdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The subdirectory within the component’s work directory</p></li>
155-
<li><p><strong>low_res</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>optional</em>) – Whether to use the low resolution configuration options</p></li>
154+
<li><p><strong>subdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The subdirectory within the component’s work directory</p></li>
155+
<li><p><strong>low_res</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a><em>, </em><em>optional</em>) – Whether to use the low resolution configuration options</p></li>
156156
</ul>
157157
</dd>
158158
</dl>

main/developers_guide/e3sm/init/generated/polaris.tasks.e3sm.init.topo.combine.CombineTask.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ <h1>polaris.tasks.e3sm.init.topo.combine.CombineTask<a class="headerlink" href="
141141
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
142142
<dd class="field-odd"><ul class="simple">
143143
<li><p><strong>component</strong> (<a class="reference internal" href="../../../generated/polaris.Component.html#polaris.Component" title="polaris.Component"><em>polaris.Component</em></a>) – The component the task belongs to</p></li>
144-
<li><p><strong>low_res</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Whether to use low resolution config options</p></li>
144+
<li><p><strong>low_res</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – Whether to use low resolution config options</p></li>
145145
</ul>
146146
</dd>
147147
</dl>

main/developers_guide/e3sm/init/generated/polaris.tasks.e3sm.init.topo.combine.VizCombinedStep.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ <h1>polaris.tasks.e3sm.init.topo.combine.VizCombinedStep<a class="headerlink" hr
146146
<dd class="field-odd"><ul class="simple">
147147
<li><p><strong>component</strong> (<a class="reference internal" href="../../../generated/polaris.Component.html#polaris.Component" title="polaris.Component"><em>polaris.Component</em></a>) – The component the step belongs</p></li>
148148
<li><p><strong>combine_step</strong> (<a class="reference internal" href="polaris.tasks.e3sm.init.topo.combine.CombineStep.html#polaris.tasks.e3sm.init.topo.combine.CombineStep" title="polaris.tasks.e3sm.init.topo.combine.CombineStep"><em>polaris.tasks.e3sm.init.topo.combine.CombineStep</em></a>) – The combine step to use for visualization</p></li>
149-
<li><p><strong>subdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The subdirectory for this step within the component’s work
149+
<li><p><strong>subdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The subdirectory for this step within the component’s work
150150
directory</p></li>
151151
</ul>
152152
</dd>

0 commit comments

Comments
 (0)