Skip to content

Commit

Permalink
a few updates, e.g. docker
Browse files Browse the repository at this point in the history
  • Loading branch information
@rjleveque
rjleveque committed Dec 30, 2022
1 parent a413e72 commit a4a5379
Show file tree
Hide file tree
Showing 1,577 changed files with 111,519 additions and 42,751 deletions.
127 changes: 66 additions & 61 deletions ClawPlotAxes.html
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>ClawPlotAxes &#8212; Clawpack 5.9.x documentation</title>
<link rel="stylesheet" href="_static/flasky.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/base.css" type="text/css" />
<link rel="stylesheet" href="_static/layout.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/flasky.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="shortcut icon" href="_static/clawicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
Expand Down Expand Up @@ -74,7 +76,8 @@ <h3>Navigation</h3>
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.9.x documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="plotting.html" >Plotting with Visclaw</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="setplot.html" accesskey="U">Using setplot.py to specify the desired plots</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="setplot.html" accesskey="U">Using setplot.py to specify the desired plots</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">ClawPlotAxes</a></li>
</ul>
</div>

Expand All @@ -83,45 +86,45 @@ <h3>Navigation</h3>
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="clawplotaxes">
<span id="id1"></span><h1>ClawPlotAxes<a class="headerlink" href="#clawplotaxes" title="Permalink to this headline"></a></h1>
<section id="clawplotaxes">
<span id="id1"></span><h1>ClawPlotAxes<a class="headerlink" href="#clawplotaxes" title="Permalink to this heading"></a></h1>
<p>For usage see <a class="reference internal" href="setplot.html#setplot"><span class="std std-ref">Using setplot.py to specify the desired plots</span></a> and <a class="reference internal" href="plotexamples.html#plotexamples"><span class="std std-ref">Plotting examples</span></a>.</p>
<p>Objects of this class are usually created by the new_plotaxes method of a
<a class="reference internal" href="ClawPlotFigure.html#clawplotfigure"><span class="std std-ref">ClawPlotFigure</span></a> object.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="setplot.html#setplot"><span class="std std-ref">Using setplot.py to specify the desired plots</span></a> and <a class="reference internal" href="plotexamples.html#plotexamples"><span class="std std-ref">Plotting examples</span></a></p>
</div>
<dl class="class">
<dt id="ClawPlotAxes">
<em class="property">class </em><code class="sig-name descname">ClawPlotAxes</code><a class="headerlink" href="#ClawPlotAxes" title="Permalink to this definition"></a></dt>
<dl class="py class">
<dt class="sig sig-object py" id="ClawPlotAxes">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ClawPlotAxes</span></span><a class="headerlink" href="#ClawPlotAxes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<div class="section" id="attributes">
<h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline"></a></h2>
<section id="attributes">
<h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2>
<blockquote>
<div><p>The following attributes can be set by the user:</p>
<dl class="attribute">
<dt>
<code class="sig-name descname">name : str</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">name</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd></dd></dl>

<dl class="attribute">
<dt>
<code class="sig-name descname">title : str</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">title</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>The title to appear at the top of the axis. Defaults to string
specified by the <em>name</em> attribute.</p>
</dd></dl>

<dl class="attribute">
<dt>
<code class="sig-name descname">title_with_t : bool</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">title_with_t</span> <span class="pre">:</span> <span class="pre">bool</span></span></dt>
<dd><p>If True, creates a title of the form “%s at time t = %s” % (title, t)</p>
</dd></dl>

<dl class="attribute">
<dt>
<code class="sig-name descname">axescmd : str</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">axescmd</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd></dd></dl>

<dl class="simple">
Expand All @@ -133,23 +136,23 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
</dd>
</dl>
<p>See the matplotlib documentation for axes.</p>
<dl class="attribute">
<dt>
<code class="sig-name descname">xlimits : array [xmin, xmax] or 'auto'</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xlimits</span> <span class="pre">:</span> <span class="pre">array</span> <span class="pre">[xmin,</span> <span class="pre">xmax]</span>&#160; <span class="pre">or</span> <span class="pre">'auto'</span></span></dt>
<dd><p>The x-axis limits if an array with two elements, or choose
automatically</p>
</dd></dl>

<dl class="attribute">
<dt>
<code class="sig-name descname">ylimits : array [ymin, ymax] or 'auto'</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">ylimits</span> <span class="pre">:</span> <span class="pre">array</span> <span class="pre">[ymin,</span> <span class="pre">ymax]</span>&#160; <span class="pre">or</span> <span class="pre">'auto'</span></span></dt>
<dd><p>The y-axis limits if an array with two elements, or choose
automatically</p>
</dd></dl>

<dl class="attribute">
<dt>
<code class="sig-name descname">afteraxes : function or str</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">afteraxes</span> <span class="pre">:</span> <span class="pre">function</span> <span class="pre">or</span> <span class="pre">str</span></span></dt>
<dd><p>A string or function that is to be executed after creating all
plot items on this axes.
If a string, this string is executed using <em>exec</em>. If a
Expand Down Expand Up @@ -180,37 +183,38 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
</div>
</dd></dl>

<dl class="attribute">
<dt>
<code class="sig-name descname">show : bool</code></dt>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">show</span> <span class="pre">:</span> <span class="pre">bool</span></span></dt>
<dd><p>If False, suppress showing this axes and all items on it.</p>
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headline"></a></h2>
</section>
<section id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this heading"></a></h2>
<blockquote>
<div><dl class="method">
<dt id="new_plotitem">
<code class="sig-name descname">new_plotitem</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">plot_type</em><span class="sig-paren">)</span><a class="headerlink" href="#new_plotitem" title="Permalink to this definition"></a></dt>
<div><dl class="py method">
<dt class="sig sig-object py" id="new_plotitem">
<span class="sig-name descname"><span class="pre">new_plotitem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#new_plotitem" title="Permalink to this definition"></a></dt>
<dd><p>Returns an object of class <a class="reference internal" href="ClawPlotItem.html#clawplotitem"><span class="std std-ref">ClawPlotItem</span></a> associated with this axes.
A single axes may have several items associated with it.</p>
<p>The name specified is used as a dictionary key. If None is provided,
one is generated automatically of the form ITEM1, etc.</p>
</dd></dl>

<dl class="method">
<dt id="gethandle">
<code class="sig-name descname">gethandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gethandle" title="Permalink to this definition"></a></dt>
<dl class="py method">
<dt class="sig sig-object py" id="gethandle">
<span class="sig-name descname"><span class="pre">gethandle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gethandle" title="Permalink to this definition"></a></dt>
<dd><p>Returns the handle for this axes.</p>
</dd></dl>

</div></blockquote>
</div>
</div>
</section>
</section>


<div class="clearer"></div>
</div>
</div>
</div>
Expand All @@ -221,15 +225,22 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
</a>
<h2>Version 5.9.x</h2>
</p>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ClawPlotAxes</a><ul>
<li><a class="reference internal" href="#ClawPlotAxes"><code class="docutils literal notranslate"><span class="pre">ClawPlotAxes</span></code></a></li>
<li><a class="reference internal" href="#attributes">Attributes</a></li>
<li><a class="reference internal" href="#methods">Methods</a></li>
<li><a class="reference internal" href="#methods">Methods</a><ul>
<li><a class="reference internal" href="#new_plotitem"><code class="docutils literal notranslate"><span class="pre">new_plotitem()</span></code></a></li>
<li><a class="reference internal" href="#gethandle"><code class="docutils literal notranslate"><span class="pre">gethandle()</span></code></a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
</li>
</ul>

</div><h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li><a href="plotting.html">Plotting with Visclaw</a><ul>
Expand Down Expand Up @@ -264,25 +275,19 @@ <h3>This Page</h3>
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/ClawPlotAxes.html">dev</a></li>
<li><a href="ClawPlotAxes.html">v5.9.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.1.x/ClawPlotAxes.html">v5.1.x</a></li>
<li><a href="./v5.2.x/ClawPlotAxes.html">v5.2.x</a></li>
<li><a href="./v5.3.x/ClawPlotAxes.html">v5.3.x</a></li>
<li><a href="./v5.4.x/ClawPlotAxes.html">v5.4.x</a></li>
<li><a href="./v5.5.x/ClawPlotAxes.html">v5.5.x</a></li>
<li><a href="./v5.6.x/ClawPlotAxes.html">v5.6.x</a></li>
<li><a href="./v5.7.x/ClawPlotAxes.html">v5.7.x</a></li>
<li><a href="./v5.8.x/ClawPlotAxes.html">v5.8.x</a></li>
</ul>
Expand Down
Loading

0 comments on commit a4a5379

Please sign in to comment.