Skip to content

Commit

Permalink
prep for v5.10.x release
Browse files Browse the repository at this point in the history
  • Loading branch information
@rjleveque
rjleveque committed Mar 25, 2024
1 parent 5401ca6 commit 37247d4
Show file tree
Hide file tree
Showing 2,178 changed files with 106,414 additions and 3,250 deletions.
11 changes: 6 additions & 5 deletions ClawPlotAxes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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>
<title>ClawPlotAxes &#8212; Clawpack 5.10.x documentation</title>
<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" />
Expand Down Expand Up @@ -74,7 +74,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="ClawPlotFigure.html" title="ClawPlotFigure"
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-0"><a href="contents.html">Clawpack 5.10.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-this"><a href="">ClawPlotAxes</a></li>
Expand Down Expand Up @@ -420,7 +420,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headin
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.9.x</h2>
<h2>Version 5.10.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -482,20 +482,21 @@ <h3 id="searchlabel">Quick search</h3>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/ClawPlotAxes.html">dev</a></li>
<li><a href="ClawPlotAxes.html">v5.9.x</a></li>
<li><a href="ClawPlotAxes.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<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>
<li><a href="./v5.9.x/ClawPlotAxes.html">v5.9.x</a></li>
</ul>

</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright CC-BY 2022, The Clawpack Development Team.
&copy; Copyright CC-BY 2024, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
Expand Down
11 changes: 6 additions & 5 deletions ClawPlotData.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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>ClawPlotData &#8212; Clawpack 5.9.x documentation</title>
<title>ClawPlotData &#8212; Clawpack 5.10.x documentation</title>
<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" />
Expand Down Expand Up @@ -74,7 +74,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="setplot.html" title="Using setplot.py to specify the desired plots"
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-0"><a href="contents.html">Clawpack 5.10.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-this"><a href="">ClawPlotData</a></li>
Expand Down Expand Up @@ -335,7 +335,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headin
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.9.x</h2>
<h2>Version 5.10.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -405,20 +405,21 @@ <h3 id="searchlabel">Quick search</h3>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/ClawPlotData.html">dev</a></li>
<li><a href="ClawPlotData.html">v5.9.x</a></li>
<li><a href="ClawPlotData.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.7.x/ClawPlotData.html">v5.7.x</a></li>
<li><a href="./v5.8.x/ClawPlotData.html">v5.8.x</a></li>
<li><a href="./v5.9.x/ClawPlotData.html">v5.9.x</a></li>
</ul>

</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright CC-BY 2022, The Clawpack Development Team.
&copy; Copyright CC-BY 2024, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
Expand Down
11 changes: 6 additions & 5 deletions ClawPlotFigure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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>ClawPlotFigure &#8212; Clawpack 5.9.x documentation</title>
<title>ClawPlotFigure &#8212; Clawpack 5.10.x documentation</title>
<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" />
Expand Down Expand Up @@ -74,7 +74,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="ClawPlotData.html" title="ClawPlotData"
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-0"><a href="contents.html">Clawpack 5.10.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-this"><a href="">ClawPlotFigure</a></li>
Expand Down Expand Up @@ -185,7 +185,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headin
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.9.x</h2>
<h2>Version 5.10.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -246,20 +246,21 @@ <h3 id="searchlabel">Quick search</h3>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/ClawPlotFigure.html">dev</a></li>
<li><a href="ClawPlotFigure.html">v5.9.x</a></li>
<li><a href="ClawPlotFigure.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.7.x/ClawPlotFigure.html">v5.7.x</a></li>
<li><a href="./v5.8.x/ClawPlotFigure.html">v5.8.x</a></li>
<li><a href="./v5.9.x/ClawPlotFigure.html">v5.9.x</a></li>
</ul>

</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright CC-BY 2022, The Clawpack Development Team.
&copy; Copyright CC-BY 2024, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
Expand Down
47 changes: 42 additions & 5 deletions ClawPlotItem.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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>ClawPlotItem &#8212; Clawpack 5.9.x documentation</title>
<title>ClawPlotItem &#8212; Clawpack 5.10.x documentation</title>
<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" />
Expand Down Expand Up @@ -74,7 +74,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="ClawPlotAxes.html" title="ClawPlotAxes"
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-0"><a href="contents.html">Clawpack 5.10.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-this"><a href="">ClawPlotItem</a></li>
Expand Down Expand Up @@ -121,10 +121,12 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
symmetric,</p></li>
<li><p>‘1d_fill_between’ : 1d filled plot between two variable specified by
the attributes <em>plot_var</em> and <em>fill_var2</em>.</p></li>
<li><p>‘2d_imshow’ : two dimentional raster plot</p></li>
<li><p>‘2d_contour’ : two dimensional contour plot,</p></li>
<li><p>‘2d_pcolor’ : two dimensional pcolor plot,</p></li>
<li><p>‘2d_schlieren’ : two dimensional Schlieren plot,</p></li>
<li><p>‘2d_patch’ : two dimensional plot of only the cell and/or patch edges, no data</p></li>
<li><p>‘2d_hillshade’ : two dimensional hillshade plot.</p></li>
</ul>
</dd></dl>

Expand Down Expand Up @@ -442,6 +444,39 @@ <h3>Special attributes for plot_type = ‘2d_imshow’<a class="headerlink" href
<dd><p>If True, a colorbar is added to the plot.</p>
</dd></dl>

</section>
<section id="special-attributes-for-plot-type-2d-hillshade">
<h3>Special attributes for plot_type = ‘2d_hillshade’<a class="headerlink" href="#special-attributes-for-plot-type-2d-hillshade" title="Permalink to this heading"></a></h3>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_vertical_exaggeration</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Vertical exaggeration for hillshade calulation. Default of 1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_azimuth_degree</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Light source azimuth angle for hillshade calculation. Default
is 315 (light coming from the northwest). Valid values are
0-360 degrees clockwise from North. The default value is recommended
for proper interpretation by most people.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_altitude_degree</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Light source altitude angle from the horizon for hillshade
calculation. Default is 45. Valid values are 0-90.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_latlon</span> <span class="pre">:</span> <span class="pre">bool</span></span></dt>
<dd><p>If True, correct the ratio between x and y units and z units
by 1/111200 to reflect that x and y units are degrees.
Default is False.</p>
</dd></dl>

</section>
</section>
<section id="amr-attributes">
Expand Down Expand Up @@ -542,7 +577,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headin
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.9.x</h2>
<h2>Version 5.10.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
Expand All @@ -558,6 +593,7 @@ <h3><a href="contents.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-contour">Special attributes for plot_type = ‘2d_contour’</a></li>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-pcolor">Special attributes for plot_type = ‘2d_pcolor’</a></li>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-imshow">Special attributes for plot_type = ‘2d_imshow’</a></li>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-hillshade">Special attributes for plot_type = ‘2d_hillshade’</a></li>
</ul>
</li>
<li><a class="reference internal" href="#amr-attributes">AMR Attributes</a></li>
Expand Down Expand Up @@ -615,20 +651,21 @@ <h3 id="searchlabel">Quick search</h3>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/ClawPlotItem.html">dev</a></li>
<li><a href="ClawPlotItem.html">v5.9.x</a></li>
<li><a href="ClawPlotItem.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.7.x/ClawPlotItem.html">v5.7.x</a></li>
<li><a href="./v5.8.x/ClawPlotItem.html">v5.8.x</a></li>
<li><a href="./v5.9.x/ClawPlotItem.html">v5.9.x</a></li>
</ul>

</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright CC-BY 2022, The Clawpack Development Team.
&copy; Copyright CC-BY 2024, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
Expand Down
28 changes: 26 additions & 2 deletions _sources/ClawPlotItem.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@ The following attributes can be set by the user:
symmetric,
* '1d_fill_between' : 1d filled plot between two variable specified by
the attributes *plot_var* and *fill_var2*.

* '2d_imshow' : two dimentional raster plot
* '2d_contour' : two dimensional contour plot,
* '2d_pcolor' : two dimensional pcolor plot,
* '2d_schlieren' : two dimensional Schlieren plot,
* '2d_patch' : two dimensional plot of only the cell and/or patch edges, no data
* '2d_hillshade' : two dimensional hillshade plot.

.. attribute:: outdir : str or None

Expand Down Expand Up @@ -306,7 +307,30 @@ Special attributes for plot_type = '2d_imshow'

If True, a colorbar is added to the plot.


Special attributes for plot_type = '2d_hillshade'
-------------------------------------------------

.. attribute:: hillshade_vertical_exaggeration : float

Vertical exaggeration for hillshade calulation. Default of 1.

.. attribute:: hillshade_azimuth_degree : float

Light source azimuth angle for hillshade calculation. Default
is 315 (light coming from the northwest). Valid values are
0-360 degrees clockwise from North. The default value is recommended
for proper interpretation by most people.

.. attribute:: hillshade_altitude_degree : float

Light source altitude angle from the horizon for hillshade
calculation. Default is 45. Valid values are 0-90.

.. attribute:: hillshade_latlon : bool

If True, correct the ratio between x and y units and z units
by 1/111200 to reflect that x and y units are degrees.
Default is False.

.. _amr_attributes:

Expand Down
30 changes: 29 additions & 1 deletion _sources/biblio.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,9 @@ Papers describing the Clawpack software and algorithms
Year = {2002},
Url = {https://www.clawpack.org/fvmhp_materials/}}
See :ref:`gallery_fvmbook` for some sample results from this book.
See the `Gallery of fvmbook applications
<https://www.clawpack.org/gallery/gallery/gallery_fvmbook.html>`__
for some sample results from this book.
.. [LeVequeGeorgeBerger]
R. J. LeVeque, D. L. George, and M. J. Berger, 2011,
Expand Down Expand Up @@ -206,6 +208,24 @@ Papers describing the Clawpack software and algorithms
Volume = {34},
Year = {2012}}
.. [KimEtAl2017]
J. Kim, G. K. Pedersen, and F. Lovholt, and R. J. LeVeque,
A Boussinesq type extension of the GeoClaw model - a study of wave
breaking phenomena applying dispersive long wave models,
Coastal Engineering 122 (2017), pp. 75-86.
DOI 10.1016/j.coastaleng.2017.01.005
::
@article{Kim201775,
title = "A Boussinesq type extension of the GeoClaw model - a study of wave
breaking phenomena applying dispersive long wave models ",
author = "Jihwan Kim and Geir K. Pedersen and Finn L{\o}vholt and Randall J. LeVeque",
journal = "Coastal Engineering ",
volume = "122",
pages = "75 - 86",
year = "2017",
doi = "http://dx.doi.org/10.1016/j.coastaleng.2017.01.005",
}
.. [MandliEtAl2016]
Kyle T. Mandli, Aron J. Ahmadia, Marsha Berger, Donna Calhoun, David L.
Expand All @@ -229,6 +249,14 @@ Papers describing the Clawpack software and algorithms
Papers describing applications
------------------------------

This list is very out of date! A
`Google Scholar search on "clawpack software"
<https://scholar.google.com/scholar?hl=en&as_sdt=0%2C48&q=clawpack+software&btnG=>`__
gives hundreds of hits that may be of interest.

For GeoClaw applications, see also `www.geoclaw.org
<http://www.geoclaw.org>`__ for additional references and other links.

.. [CalHelLeV08]
D. A. Calhoun, C. Helzel, and R. J. LeVeque.
`Logically Rectangular Grids and Finite Volume Methods for PDEs in
Expand Down
Loading

0 comments on commit 37247d4

Please sign in to comment.