Skip to content

Commit

Permalink
added v5.8.x branch as main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rjleveque
rjleveque committed Feb 5, 2021
1 parent 31cf3cf commit fd49d8c
Show file tree
Hide file tree
Showing 3,074 changed files with 94,500 additions and 2,230 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
9 changes: 5 additions & 4 deletions ClawPlotAxes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>ClawPlotAxes &#8212; Clawpack 5.7.x documentation</title>
<title>ClawPlotAxes &#8212; Clawpack 5.8.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" />
Expand Down Expand Up @@ -72,7 +72,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.7.x documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.8.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>
</ul>
Expand Down Expand Up @@ -219,7 +219,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.7.x</h2>
<h2>Version 5.8.x</h2>
</p>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
Expand Down Expand Up @@ -273,7 +273,7 @@ <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.7.x</a></li>
<li><a href="ClawPlotAxes.html">v5.8.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
Expand All @@ -283,6 +283,7 @@ <h4>Older Versions</h4>
<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>
</ul>

</div>
Expand Down
9 changes: 5 additions & 4 deletions ClawPlotData.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>ClawPlotData &#8212; Clawpack 5.7.x documentation</title>
<title>ClawPlotData &#8212; Clawpack 5.8.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" />
Expand Down Expand Up @@ -72,7 +72,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.7.x documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.8.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>
</ul>
Expand Down Expand Up @@ -331,7 +331,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.7.x</h2>
<h2>Version 5.8.x</h2>
</p>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
Expand Down Expand Up @@ -385,7 +385,7 @@ <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.7.x</a></li>
<li><a href="ClawPlotData.html">v5.8.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
Expand All @@ -395,6 +395,7 @@ <h4>Older Versions</h4>
<li><a href="./v5.4.x/ClawPlotData.html">v5.4.x</a></li>
<li><a href="./v5.5.x/ClawPlotData.html">v5.5.x</a></li>
<li><a href="./v5.6.x/ClawPlotData.html">v5.6.x</a></li>
<li><a href="./v5.7.x/ClawPlotData.html">v5.7.x</a></li>
</ul>

</div>
Expand Down
9 changes: 5 additions & 4 deletions ClawPlotFigure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>ClawPlotFigure &#8212; Clawpack 5.7.x documentation</title>
<title>ClawPlotFigure &#8212; Clawpack 5.8.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" />
Expand Down Expand Up @@ -72,7 +72,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.7.x documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.8.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>
</ul>
Expand Down Expand Up @@ -166,7 +166,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.7.x</h2>
<h2>Version 5.8.x</h2>
</p>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
Expand Down Expand Up @@ -220,7 +220,7 @@ <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.7.x</a></li>
<li><a href="ClawPlotFigure.html">v5.8.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
Expand All @@ -230,6 +230,7 @@ <h4>Older Versions</h4>
<li><a href="./v5.4.x/ClawPlotFigure.html">v5.4.x</a></li>
<li><a href="./v5.5.x/ClawPlotFigure.html">v5.5.x</a></li>
<li><a href="./v5.6.x/ClawPlotFigure.html">v5.6.x</a></li>
<li><a href="./v5.7.x/ClawPlotFigure.html">v5.7.x</a></li>
</ul>

</div>
Expand Down
9 changes: 5 additions & 4 deletions ClawPlotItem.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>ClawPlotItem &#8212; Clawpack 5.7.x documentation</title>
<title>ClawPlotItem &#8212; Clawpack 5.8.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" />
Expand Down Expand Up @@ -72,7 +72,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.7.x documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.8.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>
</ul>
Expand Down Expand Up @@ -471,7 +471,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.7.x</h2>
<h2>Version 5.8.x</h2>
</p>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
Expand Down Expand Up @@ -535,7 +535,7 @@ <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.7.x</a></li>
<li><a href="ClawPlotItem.html">v5.8.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
Expand All @@ -545,6 +545,7 @@ <h4>Older Versions</h4>
<li><a href="./v5.4.x/ClawPlotItem.html">v5.4.x</a></li>
<li><a href="./v5.5.x/ClawPlotItem.html">v5.5.x</a></li>
<li><a href="./v5.6.x/ClawPlotItem.html">v5.6.x</a></li>
<li><a href="./v5.7.x/ClawPlotItem.html">v5.7.x</a></li>
</ul>

</div>
Expand Down
45 changes: 14 additions & 31 deletions _sources/changes_to_master.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
.. _changes_to_master:

===============================
Changes to master since v5.7.1
Changes to master since v5.8.0
===============================


Follow the links to see changes that have been made to the master branch of
each repository since the last release (v5.7.1) on September 11, 2020.
each repository since the last release (v5.8.0) on February 4, 2021.

These changes should appear in the next release. If you need them now,
see :ref:`developers` for instructions on cloning and installing from the
Expand All @@ -31,57 +31,40 @@ Changes to classic


See `classic diffs
<https://github.com/clawpack/classic/compare/v5.7.1...master>`_
<https://github.com/clawpack/classic/compare/v5.8.0...master>`_

Changes to clawutil
-------------------


See `clawutil diffs
<https://github.com/clawpack/clawutil/compare/v5.7.1...master>`_
<https://github.com/clawpack/clawutil/compare/v5.8.0...master>`_

Changes to visclaw
------------------


See `visclaw diffs
<https://github.com/clawpack/visclaw/compare/v5.7.1...master>`_
<https://github.com/clawpack/visclaw/compare/v5.8.0...master>`_

Changes to riemann
------------------


See `riemann diffs
<https://github.com/clawpack/riemann/compare/v5.7.1...master>`_
<https://github.com/clawpack/riemann/compare/v5.8.0...master>`_

Changes to amrclaw
------------------


See `amrclaw diffs
<https://github.com/clawpack/amrclaw/compare/v5.7.1...master>`_
<https://github.com/clawpack/amrclaw/compare/v5.8.0...master>`_

Changes to geoclaw
------------------

Several changes were made to fix long-standing bugs. These fixes lead to
slightly different results than those obtained with previous versions of
GeoClaw. In all the tests performed so far the changes are minor and it is
thought that the new version is at least as accurate as the old version.
Please let the developers know if you run into problems that may be related
to these changes.

- In `filpatch.f90`: The slope chosen for interpolating from a
coarse grid to the ghost cells
of a fine-grid patch had an index error that could affect the
sign of the slope used in momentum components. Also slopes were
not always initialized to zero properly at the start of a loop

- Some index errors were fixed in `fgmax_interp.f90`.

- WIP: Changes to `riemann/src/rpt2_geoclaw.f90`.

See `geoclaw diffs <https://github.com/clawpack/geoclaw/compare/v5.7.1...master>`_

See `geoclaw diffs
<https://github.com/clawpack/geoclaw/compare/v5.8.0...master>`_


Changes to PyClaw
Expand All @@ -92,7 +75,7 @@ For changes in PyClaw, see the `PyClaw changelog
<https://github.com/clawpack/pyclaw/blob/master/CHANGES.md>`_.

See `pyclaw diffs
<https://github.com/clawpack/pyclaw/compare/v5.7.1...master>`_
<https://github.com/clawpack/pyclaw/compare/v5.8.0...master>`_

===========================
Other Clawpack Repositories
Expand All @@ -102,11 +85,11 @@ The repositories below are not included in the Clawpack tarfile or pip
install, but changes to these repositories may also be of interest.

- `apps diffs
<https://github.com/clawpack/apps/compare/v5.7.1...master>`_
<https://github.com/clawpack/apps/compare/v5.8.0...master>`_

- `doc diffs
<https://github.com/clawpack/doc/compare/v5.7.x...dev>`_
<https://github.com/clawpack/doc/compare/v5.8.x...dev>`_

- `docker-files diffs
<https://github.com/clawpack/docker-files/compare/v5.7.1...master>`_
<https://github.com/clawpack/docker-files/compare/v5.8.0...master>`_

2 changes: 1 addition & 1 deletion _sources/contents.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ the Clawpack open source software project.
Full Table of Contents
====================================================

This is the documentation for **Clawpack Version 5.7.1.**
This is the documentation for **Clawpack Version 5.8.0.**
For documentation corresponding to older versions see the list of
past releases in the menu to the left. The *future* version refers
to new documentation for features that have been merged into the
Expand Down
13 changes: 13 additions & 0 deletions _sources/docker_image.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@ you have `Docker <https://www.docker.com/>`_ installed then you can now use a
docker image from the `DockerHub Clawpack repositories
<https://hub.docker.com/u/clawpack/dashboard/>`_.

Using Version 5.8.0
-------------------

We are currently having problems creating a new Docker image for v5.8.0.
However, you can follow the instructions below for v5.7.1 and then within a
container, install v5.8.0 via::

jovyan $ pip install --src=$HOME/ --user -e \
git+https://github.com/clawpack/[email protected]#egg=clawpack-v5.8.0
Getting started
----------------

To download an image::

$ docker pull clawpack/v5.7.1_dockerimage:release
Expand Down
8 changes: 4 additions & 4 deletions _sources/installing.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ using the following version of the `pip install` command
want to change anything in this command)**::

pip install --src=$HOME/clawpack_src --user -e \
git+https://github.com/clawpack/clawpack.git@v5.7.1#egg=clawpack-v5.7.1
git+https://github.com/clawpack/clawpack.git@v5.8.0#egg=clawpack-v5.8.0

This will download Clawpack (via a git clone) into the directory
`$HOME/clawpack_src/clawpack-v5.7.1`. The top
`$HOME/clawpack_src/clawpack-v5.8.0`. The top
installation directory can be changed by modifying the ``--src`` target
(or omit this part to put it in your current working directory).
If you have already downloaded Clawpack via a different mechanism then
Expand All @@ -60,11 +60,11 @@ place and allowing you to modify it if desired.

In order to use the Fortran codes within Clawpack,
you should then set the environment
variable `CLAW` to point to the `clawpack-v5.7.1` directory within
variable `CLAW` to point to the `clawpack-v5.8.0` directory within
the installation directory `$HOME/clawpack_src`, and `FC` to point
to the desired Fortran compiler, e.g. in the bash shell::

export CLAW=$HOME/clawpack_src/clawpack-v5.7.1
export CLAW=$HOME/clawpack_src/clawpack-v5.8.0
export FC=gfortran

See :ref:`setenv` for more information.
Expand Down
6 changes: 3 additions & 3 deletions _sources/installing_more_options.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Download a tar file from one of these sources:

After downloading a tar file you can do, e.g. ::

tar -xzf clawpack-v5.7.1.tar.gz
cd clawpack-v5.7.1
tar -xzf clawpack-v5.8.0.tar.gz
cd clawpack-v5.8.0
pip install --user -e . # note trailing dot indicating "this directory"
export CLAW=/full/path/to/clawpack-v5.7.1
export CLAW=/full/path/to/clawpack-v5.8.0
.. _install_dev:

Expand Down
10 changes: 5 additions & 5 deletions _sources/installing_pip.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ install command
want to change anything in this command)**::

pip install --src=$HOME/clawpack_src --user -e \
git+https://github.com/clawpack/clawpack.git@v5.7.1#egg=clawpack-v5.7.1
git+https://github.com/clawpack/clawpack.git@v5.8.0#egg=clawpack-v5.8.0

This will download Clawpack (via a git clone) into the directory
`$HOME/clawpack_src/clawpack-v5.7.1`. The top
`$HOME/clawpack_src/clawpack-v5.8.0`. The top
installation directory can be changed by modifying the ``--src`` target
(or omit this part to put it in your current working directory).
If you have already downloaded Clawpack via a different mechanism then
Expand All @@ -68,11 +68,11 @@ place and allowing you to modify it if desired.

In order to use the Fortran codes within Clawpack (`classic`,
`amrclaw`, or `geoclaw`), you should then set the environment
variable `CLAW` to point to the `clawpack-v5.7.1` directory within
variable `CLAW` to point to the `clawpack-v5.8.0` directory within
the installation directory `$HOME/clawpack_src`, and `FC` to point
to the desired Fortran compiler, e.g. in the bash shell::

export CLAW=$HOME/clawpack_src/clawpack-v5.7.1
export CLAW=$HOME/clawpack_src/clawpack-v5.8.0
export FC=gfortran

**Notes:**
Expand Down Expand Up @@ -101,7 +101,7 @@ tools, e.g. VisClaw for visualization), they you could do::

or, more specifically, ::

pip install --user clawpack==v5.7.1
pip install --user clawpack==v5.8.0

However, if you think you might want to use the Fortran packages as well
(Classic, AMRClaw, GeoClaw) and/or want easier access to the Python source
Expand Down
Loading

0 comments on commit fd49d8c

Please sign in to comment.