begin_html  [use: doc/doc.css]
<!--   For a more readable version of this file, execute
                  unix>  make htmls
       in this directory and then point your browser to README.html 
     --------------------------------------------------------------  -->

<h2>
GeoClaw Sample Code
</h2>

Sample earthquake-generated tsunami based on the 2010 Chile event.
Primarily to illustrate how set up topo and dtopo files.

See [claw: doc/sphinx/users/topo.html] for more information.

See [code: maketopo.py].  This downloads topography data from the 
[http://kingkong.amath.washington.edu/topo/ GeoClaw topography database]
that originally came from the
NOAA National Geophysical Data Center (NGDC)
using [http://www.ngdc.noaa.gov/mgg/gdas/gd_designagrid.html Design-a-grid].


USGS site for earthquake data:
[http://earthquake.usgs.gov/earthquakes/eqinthenews/2010/us2010tfan]

Note: This fault model has be updated since this example was originally
constructed, and the GeoClaw source code has been improved to use a
combination of 180 subfaults specified at
[http://earthquake.usgs.gov/earthquakes/eqinthenews/2010/us2010tfan/finite_fault.php]
in place of the single fault plane used in the example included in Clawpack
4.5.1 and before.

One gauge is included at the location of DART Buoy 32412:
[http://www.ndbc.noaa.gov/station_page.php?station=32412]

To download other DART buoy data, see
[http://www.ndbc.noaa.gov/dart.shtml]


See also the NOAA/PMEL Center for Tsunami Research
site for this tsunami, containing DART data, tide gauges, MOST simulations:
[http://nctr.pmel.noaa.gov/chile20100227/]


<h4>
Plots of results
</h4>

To create all these directories of plots, use 

{{{
  $ source make_all.sh
}}}

Plots created:

<ul>
<li> [link: _plots/_PlotIndex.html] 3 level run
<li> [link: _plots_noamr/_PlotIndex.html] single level with same resolution
<li> [link: _plots_4levels/_PlotIndex.html] 4 levels with higher resolution
</ul>

The script [code: compare_gauges.py] can be used plot a comparison of the gauge
data for all three runs with the DART Buoy 32412 data, resulting in a plot 
<a href="dart_gauges.png">dart_gauges.png</a>.

The script [code: plot_dart.py] is a version that plots on top of
computational results obtained by NOAA,
<a href="dart.png">dart.png</a>.

<h4>
Fortran files
</h4>


<dl>
<dt>[code: Makefile]
<dd> Determines which version of fortran files
are used when compiling the code with make and specifies where output and
plots should be directed.  Type "make .help" at the Unix prompt for options.


<dt>[code: setprob.f]
<dd>
Standard for for GeoClaw


</dl>

<h4>
Python files
</h4>
<dl>

<dt>[code: maketopo.py]
<dd> Used to create topo file and dtopo data file.

<dt>[code: subfaults.py]
<dd> Used to create dtopo file from the file [code: subfault.txt], obtained
from 
[http://earthquake.usgs.gov/earthquakes/eqinthenews/2010/us2010tfan/finite_fault.php].

<dt>[code: setrun.py]
<dd> This file contains a function that 
specifies what run-time parameters will be used.

<dt>[code: setplot.py]
<dd> This file contains a function that 
specifies what plots will be done and
sets various plotting parameters. 

<dt>[code: setplot_imshow.py]
<dd> Version of setplot illustrating how the '2d_imshow'
plot type can be used in place of '2d_pcolor'.  This plots much faster.

<dt>[code: plot_dart.py]
<dd> This file contains a 
script that can be used plot a comparison of the gauge
data with the DART Buoy 32412 data.
</dl>


<h4>
Data files
</h4>

The .data files are automatically generated using the information in 
[code: setrun.py].


<h4>
Instructions
</h4>


To make topo and dtopo data files:
{{{
  $ make topo
}}}

To make all data files, edit setrun.py and then
{{{
  $ make .data
}}}

To run code:
{{{
  $ make .output
}}}

To plot results, either generate html pages via:
{{{
  $ make .plots
}}}
or view interactively using ipython and Iplotclaw.

To run the 3 different cases for the figures in the paper,
{{{
  $ source make_all.sh
}}}

For more documentation, see
[http://www.clawpack.org/users].

end_html