Skip to content

Commit

Permalink
Update Sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@geomorphysics
geomorphysics committed Mar 21, 2022
1 parent 81e2de7 commit e3423ca
Show file tree
Hide file tree
Showing 6 changed files with 177 additions and 159 deletions.
291 changes: 146 additions & 145 deletions docs/modules/image.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/modules/initialize.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h2>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶
<span class="k">return</span> <span class="kc">True</span>


<span class="n">is_python</span> <span class="o">=</span> <span class="n">check_is_ipython</span><span class="p">()</span>
<span class="n">is_python</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="n">check_is_ipython</span><span class="p">()</span>

<span class="k">if</span> <span class="n">is_python</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/parameters.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h3>Navigation</h3>

<dl class="py class">
<dt class="sig sig-object py" id="gmplib.parameters.ParametersNestedGroup">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">gmplib.parameters.</span></span><span class="sig-name descname"><span class="pre">ParametersNestedGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters_dict</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evaluations</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></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="headerlink" href="#gmplib.parameters.ParametersNestedGroup" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">gmplib.parameters.</span></span><span class="sig-name descname"><span class="pre">ParametersNestedGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#gmplib.parameters.Parameters" title="gmplib.parameters.Parameters"><span class="pre">gmplib.parameters.Parameters</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters_dict</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evaluations</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></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="headerlink" href="#gmplib.parameters.ParametersNestedGroup" title="Permalink to this definition"></a></dt>
<dd><p>Provide a job <cite>ParametersNestedGroup</cite> sub-container.</p>
<p>Convert items in a parameters sub-dictionary into class attributes,
setting the attribute name to the dict item’s key and the
Expand All @@ -122,7 +122,7 @@ <h3>Navigation</h3>

<dl class="py method">
<dt class="sig sig-object py" id="gmplib.parameters.ParametersNestedGroup.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters_dict</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evaluations</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></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> &#x2192; <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a><a class="headerlink" href="#gmplib.parameters.ParametersNestedGroup.__init__" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#gmplib.parameters.Parameters" title="gmplib.parameters.Parameters"><span class="pre">gmplib.parameters.Parameters</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters_dict</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evaluations</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></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> &#x2192; <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a><a class="headerlink" href="#gmplib.parameters.ParametersNestedGroup.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Initialize.</p>
</dd></dl>

Expand Down Expand Up @@ -360,7 +360,7 @@ <h2>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">parent</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
<span class="n">parent</span><span class="p">:</span> <span class="n">Parameters</span><span class="p">,</span>
<span class="n">group_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">parameters_dict</span><span class="p">:</span> <span class="n">Dict</span><span class="p">,</span>
<span class="n">evaluations</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
Expand Down
28 changes: 22 additions & 6 deletions docs/modules/plot.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ <h2>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">from</span> <span class="nn">itertools</span> <span class="kn">import</span> <span class="n">cycle</span>
<span class="kn">import</span> <span class="nn">operator</span> <span class="k">as</span> <span class="nn">op</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">List</span> <span class="c1"># , Callable</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Sized</span>

<span class="c1"># MatPlotLib</span>
<span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
Expand Down Expand Up @@ -333,22 +333,38 @@ <h2>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶
<span class="sd"> return i^th marker</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">dpi</span><span class="p">:</span> <span class="nb">int</span>
<span class="n">font_size</span><span class="p">:</span> <span class="nb">int</span>
<span class="n">fdict</span><span class="p">:</span> <span class="n">Dict</span>
<span class="n">colors</span><span class="p">:</span> <span class="n">Callable</span>
<span class="n">n_colors</span><span class="p">:</span> <span class="nb">int</span>
<span class="n">color_cycle</span><span class="p">:</span> <span class="n">Callable</span>
<span class="n">markers</span><span class="p">:</span> <span class="n">Tuple</span>
<span class="n">n_markers</span><span class="p">:</span> <span class="nb">int</span>
<span class="n">marker_cycle</span><span class="p">:</span> <span class="n">cycle</span>
<span class="n">linestyle_list</span><span class="p">:</span> <span class="n">Tuple</span>
<span class="n">color</span><span class="p">:</span> <span class="n">Callable</span>
<span class="n">marker</span><span class="p">:</span> <span class="n">Callable</span>
<span class="n">font_family</span><span class="p">:</span> <span class="nb">str</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dpi</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">100</span><span class="p">,</span> <span class="n">font_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">11</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Initialize.&quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dpi</span> <span class="o">=</span> <span class="n">dpi</span>
<span class="bp">self</span><span class="o">.</span><span class="n">font_size</span> <span class="o">=</span> <span class="n">font_size</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fdict</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">prop_cycle</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s2">&quot;axes.prop_cycle&quot;</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colors</span> <span class="o">=</span> <span class="n">prop_cycle</span><span class="o">.</span><span class="n">by_key</span><span class="p">()[</span><span class="s2">&quot;color&quot;</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n_colors</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">colors</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">color_cycle</span> <span class="o">=</span> <span class="n">cycle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">colors</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colors</span> <span class="o">=</span> <span class="n">prop_cycle</span><span class="o">.</span><span class="n">by_key</span><span class="p">()[</span><span class="s2">&quot;color&quot;</span><span class="p">]</span> <span class="c1"># type: ignore</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n_colors</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">colors</span><span class="p">)</span> <span class="c1"># type: ignore</span>
<span class="bp">self</span><span class="o">.</span><span class="n">color_cycle</span> <span class="o">=</span> <span class="n">cycle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">colors</span><span class="p">)</span> <span class="c1"># type: ignore</span>
<span class="bp">self</span><span class="o">.</span><span class="n">markers</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;o&quot;</span><span class="p">,</span> <span class="s2">&quot;s&quot;</span><span class="p">,</span> <span class="s2">&quot;v&quot;</span><span class="p">,</span> <span class="s2">&quot;p&quot;</span><span class="p">,</span> <span class="s2">&quot;*&quot;</span><span class="p">,</span> <span class="s2">&quot;D&quot;</span><span class="p">,</span> <span class="s2">&quot;X&quot;</span><span class="p">,</span> <span class="s2">&quot;^&quot;</span><span class="p">,</span> <span class="s2">&quot;h&quot;</span><span class="p">,</span> <span class="s2">&quot;P&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n_markers</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">markers</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">marker_cycle</span> <span class="o">=</span> <span class="n">cycle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">markers</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">linestyle_list</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;solid&quot;</span><span class="p">,</span> <span class="s2">&quot;dashdot&quot;</span><span class="p">,</span> <span class="s2">&quot;dashed&quot;</span><span class="p">,</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)))</span>

<span class="bp">self</span><span class="o">.</span><span class="n">color</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">i_</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colors</span><span class="p">[</span><span class="n">i_</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_colors</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">marker</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">i_</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">markers</span><span class="p">[</span><span class="n">i_</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_markers</span><span class="p">]</span>
<span class="n">color_</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">i_</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colors</span><span class="p">[</span><span class="n">i_</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_colors</span><span class="p">]</span> <span class="c1"># type: ignore</span>
<span class="n">marker_</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">i_</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">markers</span><span class="p">[</span><span class="n">i_</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_markers</span><span class="p">]</span> <span class="c1"># type: ignore</span>
<span class="bp">self</span><span class="o">.</span><span class="n">color</span> <span class="o">=</span> <span class="n">color_</span> <span class="c1"># type: ignore</span>
<span class="bp">self</span><span class="o">.</span><span class="n">marker</span> <span class="o">=</span> <span class="n">marker_</span> <span class="c1"># type: ignore</span>
<span class="bp">self</span><span class="o">.</span><span class="n">font_family</span> <span class="o">=</span> <span class="s2">&quot;Arial&quot;</span> <span class="k">if</span> <span class="s2">&quot;Arial&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fonts</span><span class="p">()</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
<span class="n">mpl</span><span class="o">.</span><span class="n">rc</span><span class="p">(</span><span class="s2">&quot;font&quot;</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">font_size</span><span class="p">,</span> <span class="n">family</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">font_family</span><span class="p">)</span>

Expand Down
Loading

0 comments on commit e3423ca

Please sign in to comment.