-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathcontents.html
563 lines (552 loc) · 40.2 KB
/
contents.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Full Table of Contents — Clawpack 5.2.1 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/graphviz.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.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>
<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" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About this software" href="about.html" />
</head><body>
<div id="main-wrapper" class="sphinx">
<div id="header-wrapper">
<section id="header">
<!-- <h1><a href="http://clawpack.org/">Clawpack</a></h1> -->
<h1><a href="http://clawpack.org/">Clawpack-5</a></h1>
<nav>
<ul>
<li>
<a href="#">Docs</a>
</li>
<li>
<a href="installing.html">Install</a>
</li>
<li>
<a class="" href="http://clawpack.org/gallery/index.html">Gallery</a>
</li>
<li>
<a href="about.html">Citation</a>
</li>
<li>
<a class="active" href="http://github.com/clawpack">GitHub</a>
</li>
<li>
<a class="" href="community.html">Community</a>
</li>
<li>
<a class="" href="developers.html">Contribute</a>
</li>
</ul>
</nav>
</section>
<div class="decoration"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="about.html" title="About this software"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Clawpack 5.2.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="full-table-of-contents">
<span id="contents"></span><h1>Full Table of Contents<a class="headerlink" href="#full-table-of-contents" title="Permalink to this headline">¶</a></h1>
<p><a class="reference internal" href="toc_condensed.html#toc-condensed"><span class="std std-ref">Condensed Table of Contents</span></a></p>
<div class="section" id="overview-and-getting-started">
<h2>Overview and Getting Started:<a class="headerlink" href="#overview-and-getting-started" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">About this software</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#authors">Authors</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#citing-this-work">Citing this work</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#funding">Funding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Recent changes — release notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changes.html#clawpack-5-x">Clawpack 5.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#clawpack-4-x">Clawpack 4.x</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installing.html">Installation instructions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installing.html#install-only-pyclaw-serial">Install only PyClaw (serial)</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing.html#install-all-clawpack-packages">Install all Clawpack packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing.html#install-other-packages-without-compiling-pyclaw">Install other packages without compiling PyClaw</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing.html#install-only-pyclaw-for-running-in-parallel">Install only PyClaw (for running in parallel)</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing.html#install-the-latest-development-version">Install the latest development version</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing.html#alternative-ways-of-running-clawpack">Alternative ways of running Clawpack</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing.html#testing-your-installation">Testing your installation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="first_run.html">Running an example</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="trouble.html">Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="trouble.html#installation">Installation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="packages.html">Which Clawpack solver should I use?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="packages.html#installation-and-user-interface">Installation and user interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="packages.html#algorithmic-differences">Algorithmic differences</a></li>
<li class="toctree-l2"><a class="reference internal" href="packages.html#parallel-computing">Parallel computing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="clawpack_components.html">Clawpack components</a><ul>
<li class="toctree-l2"><a class="reference internal" href="clawpack_components.html#other-repositories">Other repositories</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vm.html">Clawpack Virtual Machine</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws.html">Amazon Web Services EC2 Clawpack AMI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="aws.html#finding-the-clawpack-ami">Finding the Clawpack AMI</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#launching-an-instance">Launching an instance</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#logging-on-to-your-instance">Logging on to your instance</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#using-clawpack">Using Clawpack</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#viewing-plots-of-results">Viewing plots of results</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#viewing-webpages-directly-from-your-instance">Viewing webpages directly from your instance</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#transferring-files-to-from-your-instance">Transferring files to/from your instance</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#stopping-your-instance">Stopping your instance</a></li>
<li class="toctree-l2"><a class="reference internal" href="aws.html#creating-your-own-ami">Creating your own AMI</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="previous.html">Previous versions of Clawpack</a></li>
</ul>
</div>
</div>
<div class="section" id="examples-and-applications">
<h2>Examples and Applications:<a class="headerlink" href="#examples-and-applications" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="galleries.html">Galleries of all Clawpack applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="apps.html">Clawpack Applications repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="book.html">Examples from the book FVMHP</a></li>
<li class="toctree-l1"><a class="reference internal" href="newapp.html">Creating a new application directory</a></li>
<li class="toctree-l1"><a class="reference internal" href="sharing.html">Saving and sharing results</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing your installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="sphinxdoc.html">Compiling the Sphinx documentation locally</a></li>
</ul>
</div>
</div>
<div class="section" id="fortran-and-python-codes">
<h2>Fortran and Python codes:<a class="headerlink" href="#fortran-and-python-codes" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="fortran.html">Fortran version</a><ul>
<li class="toctree-l2"><a class="reference internal" href="fortran.html#makefiles">Makefiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="fortran.html#more-tips">More tips</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="fortran_compilers.html">Fortran Compilers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="fortran_compilers.html#fc-environment-variable"><cite>FC</cite> environment variable</a></li>
<li class="toctree-l2"><a class="reference internal" href="fortran_compilers.html#fflags-environment-variable"><cite>FFLAGS</cite> environment variable</a></li>
<li class="toctree-l2"><a class="reference internal" href="fortran_compilers.html#gfortran-compiler">gfortran compiler</a></li>
<li class="toctree-l2"><a class="reference internal" href="fortran_compilers.html#intel-fortran-compiler">Intel fortran compiler</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_routines.html">User files required for the Fortran code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#specifying-the-initial-conditions">Specifying the initial conditions</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#specifying-the-riemann-solver">Specifying the Riemann solver</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#specifying-boundary-conditions">Specifying boundary conditions</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#specifying-problem-specific-data">Specifying problem-specific data</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#specifying-spatially-varying-data-using-setaux">Specifying spatially-varying data using <cite>setaux</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#using-b4step-for-work-to-be-done-before-each-time-step">Using <cite>b4step</cite> for work to be done before each time step</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#using-src-for-source-terms">Using <cite>src</cite> for source terms</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_routines.html#using-src1d-for-source-terms-with-amrclaw">Using <cite>src1d</cite> for source terms with AMRClaw</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="openmp.html">Using OpenMP</a><ul>
<li class="toctree-l2"><a class="reference internal" href="openmp.html#using-openmp-with-amr">Using OpenMP with AMR</a></li>
<li class="toctree-l2"><a class="reference internal" href="openmp.html#fixed-grid-output-in-geoclaw">Fixed grid output in GeoClaw</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python Hints</a><ul>
<li class="toctree-l2"><a class="reference internal" href="python.html#installation-of-required-modules">Installation of required modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="python.html#references-and-tutorials">References and tutorials</a></li>
<li class="toctree-l2"><a class="reference internal" href="python.html#notebooks">Notebooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="python.html#sage">Sage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">IPython notebook examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="makefiles.html">Clawpack Makefiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="makefiles.html#applications-directory-makefiles">Applications directory Makefiles</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="application_documentation.html">Application documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="application_documentation.html#converting-readme-rst-to-readme-html">Converting README.rst to README.html</a></li>
<li class="toctree-l2"><a class="reference internal" href="application_documentation.html#converting-code-to-html-with-clawcode2html">Converting code to html with clawcode2html</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="setrun.html">Specifying classic run-time parameters in <cite>setrun.py</cite></a><ul>
<li class="toctree-l2"><a class="reference internal" href="setrun.html#input">Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun.html#output">Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun.html#run-time-parameters">Run-time parameters</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="setrun_sample.html">Sample <cite>setrun.py</cite> module for classic Clawpack</a></li>
<li class="toctree-l1"><a class="reference internal" href="bc.html">Boundary conditions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bc.html#boundary-conditions-for-adaptive-refinement">Boundary conditions for adaptive refinement</a></li>
<li class="toctree-l2"><a class="reference internal" href="bc.html#boundary-conditions-for-geoclaw">Boundary conditions for GeoClaw</a></li>
<li class="toctree-l2"><a class="reference internal" href="bc.html#boundary-conditions-for-clamshell-grids-on-the-sphere">Boundary conditions for clamshell grids on the sphere</a></li>
<li class="toctree-l2"><a class="reference internal" href="bc.html#user-defined-boundary-conditions">User-defined boundary conditions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="output_styles.html">Output data formats</a><ul>
<li class="toctree-l2"><a class="reference internal" href="output_styles.html#ascii-output-data-format">ASCII output data format</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_styles.html#raw-binary-output-data-format">Raw binary output data format</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_styles.html#netcdf-output-data-format">NetCDF output data format</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_styles.html#output-of-aux-arrays">Output of aux arrays</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mapc2p.html">The mapc2p function</a></li>
<li class="toctree-l1"><a class="reference internal" href="restart.html">Checkpointing and restarting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="restart.html#checkpointing-a-computation">Checkpointing a computation</a></li>
<li class="toctree-l2"><a class="reference internal" href="restart.html#restarting-a-computation">Restarting a computation</a></li>
<li class="toctree-l2"><a class="reference internal" href="restart.html#modifying-the-makefile-for-a-restart">Modifying the Makefile for a restart</a></li>
<li class="toctree-l2"><a class="reference internal" href="restart.html#output-files-after-a-restart">Output files after a restart</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="visclaw-plotting-and-visualization-tools">
<h2>VisClaw: Plotting and Visualization Tools<a class="headerlink" href="#visclaw-plotting-and-visualization-tools" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="plotting.html">Visclaw Plotting options</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plotting.html#plotting-as-post-processing">Plotting as post-processing</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting.html#plotting-on-the-fly">Plotting on the fly</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plotting_python.html">Plotting options in Python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plotting_python.html#producing-html-plots-from-the-command-line">Producing html plots from the command line</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_python.html#producing-a-latex-file-with-plots-from-the-command-line">Producing a latex file with plots from the command line</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_python.html#setting-plot-parameters-with-a-setplot-function">Setting plot parameters with a setplot function</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_python.html#interactive-plotting-with-iplotclaw">Interactive plotting with <cite>Iplotclaw</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_python.html#printframes">printframes</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_python.html#specifying-what-and-how-to-plot">Specifying what and how to plot</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="setplot.html">Using setplot.py to specify the desired plots</a><ul>
<li class="toctree-l2"><a class="reference internal" href="setplot.html#plotting-data-objects">Plotting Data Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="setplot.html#overview">Overview</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="current_data.html">current_data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="current_data.html#attributes-of-current-data">Attributes of <em>current_data</em>:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plotexamples.html">Plotting examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="plotting_faq.html">Plotting hints and FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#what-s-the-difference-between-make-plots-and-make-plots">What’s the difference between <cite>make .plots</cite> and <cite>make plots</cite> ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-plot-a-something-other-than-a-component-of-q">How to plot a something other than a component of q?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-add-another-curve-to-a-plot-e-g-the-true-solution">How to add another curve to a plot, e.g. the true solution?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-change-the-title-in-a-plot">How to change the title in a plot?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-specify-outdir-the-directory-to-find-fort-files-for-plotting">How to specify <code class="docutils literal notranslate"><span class="pre">outdir</span></code>, the directory to find <code class="docutils literal notranslate"><span class="pre">fort.*</span></code> files for plotting?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-specify-a-different-outdir-for-some-plot-item">How to specify a different <code class="docutils literal notranslate"><span class="pre">outdir</span></code> for some plot item?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-set-plot-parameters-that-are-not-provided-as-attributes-of-clawplotitem">How to set plot parameters that are not provided as attributes of <span class="xref std std-ref">ClawPlotItem</span>?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-change-the-size-or-background-color-of-a-figure">How to change the size or background color of a figure?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#specifying-colormaps-for-pcolor-or-contourf-plots">Specifying colormaps for pcolor or contourf plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting_faq.html#how-to-debug-setplot-py">How to debug setplot.py?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="geoplot.html">GeoClaw plotting tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="geoplot.html#plotting-water-depth-or-surface-elevation">Plotting water depth or surface elevation</a></li>
<li class="toctree-l2"><a class="reference internal" href="geoplot.html#tips-on-latitude-longitude-coordinate-axes">Tips on latitude-longitude coordinate axes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="matlab_plotting.html">Plotting using Matlab</a><ul>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#the-matlab-search-path">The Matlab search path</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#creating-output-files">Creating output files</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#the-plotclaw-command">The plotclaw command</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#the-setplot-file">The setplot file</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#the-afterframe-file">The afterframe file</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#getting-help">Getting help</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#trouble-shooting">Trouble shooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlab_plotting.html#matlab-gallery">Matlab Gallery</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="visit_plotting.html">Plotting with VisIt</a></li>
</ul>
</div>
</div>
<div class="section" id="amrclaw-adaptive-mesh-refinement">
<h2>AMRClaw: Adaptive Mesh Refinement<a class="headerlink" href="#amrclaw-adaptive-mesh-refinement" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="amrclaw.html">AMRClaw</a></li>
<li class="toctree-l1"><a class="reference internal" href="setrun_amrclaw.html">Specifying AMRClaw run-time parameters in <cite>setrun.py</cite></a><ul>
<li class="toctree-l2"><a class="reference internal" href="setrun_amrclaw.html#input">Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_amrclaw.html#output">Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_amrclaw.html#run-time-parameters">Run-time parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_amrclaw.html#special-amr-parameters">Special AMR parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_amrclaw.html#debugging-flags-for-additional-printing">Debugging flags for additional printing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="setrun_amrclaw_sample.html">Sample <cite>setrun.py</cite> module for AMRClaw</a></li>
<li class="toctree-l1"><a class="reference internal" href="amr_algorithm.html">Adaptive mesh refinement (AMR) algorithms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="amr_algorithm.html#ghost-cells-and-boundary-conditions-for-amr">Ghost cells and boundary conditions for AMR</a></li>
<li class="toctree-l2"><a class="reference internal" href="amr_algorithm.html#choosing-and-initializing-finer-grids">Choosing and initializing finer grids</a></li>
<li class="toctree-l2"><a class="reference internal" href="amr_algorithm.html#flagging-cells-for-refinement">Flagging cells for refinement</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="refinement.html">AMR refinement criteria</a><ul>
<li class="toctree-l2"><a class="reference internal" href="refinement.html#flagging-criteria">Flagging criteria</a></li>
<li class="toctree-l2"><a class="reference internal" href="refinement.html#specifying-amr-regions">Specifying AMR regions</a></li>
<li class="toctree-l2"><a class="reference internal" href="refinement.html#flagging-criteria-in-geoclaw">Flagging criteria in GeoClaw</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gauges.html">Gauges</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gauges.html#gauge-parameters-in-setrun">Gauge parameters in setrun</a></li>
<li class="toctree-l2"><a class="reference internal" href="gauges.html#plotting-tools">Plotting tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="gauges.html#plotting-gauge-locations">Plotting gauge locations</a></li>
<li class="toctree-l2"><a class="reference internal" href="gauges.html#examples">Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="geoclaw-for-geophysical-flows">
<h2>GeoClaw: For geophysical flows<a class="headerlink" href="#geoclaw-for-geophysical-flows" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="geoclaw.html">GeoClaw</a><ul>
<li class="toctree-l2"><a class="reference internal" href="geoclaw.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="geoclaw.html#running-a-geoclaw-code">Running a GeoClaw code</a></li>
<li class="toctree-l2"><a class="reference internal" href="geoclaw.html#topography">Topography</a></li>
<li class="toctree-l2"><a class="reference internal" href="geoclaw.html#plotting-geoclaw-results">Plotting GeoClaw results</a></li>
<li class="toctree-l2"><a class="reference internal" href="geoclaw.html#setting-up-a-new-example">Setting up a new example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="geohints.html">Cautionary Hints on using GeoClaw</a><ul>
<li class="toctree-l2"><a class="reference internal" href="geohints.html#tsunami-hazard-modeling">Tsunami hazard modeling</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="topo.html">Topography data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="topo.html#downloading-topography-files">Downloading topography files</a></li>
<li class="toctree-l2"><a class="reference internal" href="topo.html#topography-displacement-files">Topography displacement files</a></li>
<li class="toctree-l2"><a class="reference internal" href="topo.html#qinit-data-file">qinit data file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="topotools.html">Python tools for working with topo and dtopo</a></li>
<li class="toctree-l1"><a class="reference internal" href="setrun_geoclaw.html">Specifying GeoClaw parameters in <cite>setrun.py</cite></a><ul>
<li class="toctree-l2"><a class="reference internal" href="setrun_geoclaw.html#additional-amr-parameters">Additional AMR parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_geoclaw.html#general-geo-parameters">General geo parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_geoclaw.html#topography-data-file-parameters">Topography data file parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_geoclaw.html#qinit-data-file-parameters">qinit data file parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_geoclaw.html#amr-refinement-region-parameters">AMR refinement region parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_geoclaw.html#fixed-grid-output-parameters">Fixed grid output parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="setrun_geoclaw.html#fixed-grid-maximum-monitoring-arrival-times">Fixed grid maximum monitoring / arrival times</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plotting_geoclaw.html">Plotting routines for GeoClaw</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_tsunami.html">Quick start guide for tsunami modeling</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quick_tsunami.html#get-bathymetry-and-topography">Get bathymetry and topography</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_tsunami.html#specifying-topo-in-setrun-py">Specifying topo in <cite>setrun.py</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_tsunami.html#specifying-dtopo-in-setrun-py">Specifying dtopo in <cite>setrun.py</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_tsunami.html#setting-other-parameters-in-setrun-py">Setting other parameters in setrun.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_tsunami.html#setting-gauges">Setting gauges</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="okada.html">Earthquake sources: Fault slip and the Okada model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="okada.html#fault-slip">Fault slip</a></li>
<li class="toctree-l2"><a class="reference internal" href="okada.html#okada-model">Okada model</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sealevel.html">Setting sealevel</a></li>
<li class="toctree-l1"><a class="reference internal" href="manning.html">Manning friction term</a></li>
<li class="toctree-l1"><a class="reference internal" href="fgout.html">Fixed grid output</a></li>
<li class="toctree-l1"><a class="reference internal" href="fgmax.html">Fixed grid monitoring</a><ul>
<li class="toctree-l2"><a class="reference internal" href="fgmax.html#input-file-specification">Input file specification</a></li>
<li class="toctree-l2"><a class="reference internal" href="fgmax.html#tools-to-create-a-input-file">Tools to create a input file</a></li>
<li class="toctree-l2"><a class="reference internal" href="fgmax.html#values-to-monitor">Values to monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="fgmax.html#choice-of-interpolation-procedure">Choice of interpolation procedure</a></li>
<li class="toctree-l2"><a class="reference internal" href="fgmax.html#processing-and-plotting-fgmax-output">Processing and plotting fgmax output</a></li>
<li class="toctree-l2"><a class="reference internal" href="fgmax.html#format-of-the-output-files">Format of the output files</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tsunamidata.html">Some sources of tsunami data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tsunamidata.html#topography-bathymetry">Topography / bathymetry</a></li>
<li class="toctree-l2"><a class="reference internal" href="tsunamidata.html#earthquake-source-models">Earthquake source models</a></li>
<li class="toctree-l2"><a class="reference internal" href="tsunamidata.html#dart-buoy-data">DART buoy data</a></li>
<li class="toctree-l2"><a class="reference internal" href="tsunamidata.html#tide-gauges">Tide gauges</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="pyclaw-python-tools">
<h2>PyClaw: Python tools<a class="headerlink" href="#pyclaw-python-tools" title="Permalink to this headline">¶</a></h2>
<p>Includes PetClaw, Using PETSc for parallel efficiency.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pyclaw/index.html">Pyclaw</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyclaw/index.html#pyclaw-is">PyClaw is:</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyclaw/index.html#pyclaw-documentation">PyClaw Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/basics.html">PyClaw Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/going_further.html">Going Further</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/classes.html">Understanding Pyclaw Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/for_developers.html">Information for developers</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/about.html">About PyClaw</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/future.html">Future work</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/gallery/how-to-build.html">Building the PyClaw gallery locally</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/index.html#pyclaw-modules-reference-documentation">PyClaw Modules reference documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/index.html#riemann-solvers-reference-documentation">Riemann Solvers reference documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/index.html#indices-and-tables">Indices and tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyclaw/index.html#citing">Citing</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="sharpclaw-high-order-methods">
<h2>SharpClaw: High-order methods<a class="headerlink" href="#sharpclaw-high-order-methods" title="Permalink to this headline">¶</a></h2>
<p>SharpClaw has recently been integrated into PyClaw/PetClaw along with very high order WENO reconstruction through PyWENO code generation. The
<a class="reference external" href="http://bitbucket.org/ketch/sharpclaw">pure Fortran SharpClaw code</a> is no longer supported.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pyclaw/solvers.html">Using PyClaw’s solvers: Classic and SharpClaw</a></li>
</ul>
</div>
</div>
<div class="section" id="developers-resources">
<h2>Developers’ resources<a class="headerlink" href="#developers-resources" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="developers.html">Developers’ Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="git_resources.html">git resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto_doc.html">Guide for updating this documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="regression.html">Regression testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="git_versions.html">Keeping track of git versions</a></li>
</ul>
</div>
<p>See also <a class="reference internal" href="developers.html#setup-dev"><span class="std std-ref">Installation instructions for developers</span></a></p>
</div>
<div class="section" id="bibliography">
<h2>Bibliography<a class="headerlink" href="#bibliography" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="fvmbook.html">FVMHP book</a></li>
<li class="toctree-l1"><a class="reference internal" href="biblio.html">Bibliography</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.2.1</h2>
</p>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Full Table of Contents</a><ul>
<li><a class="reference internal" href="#overview-and-getting-started">Overview and Getting Started:</a></li>
<li><a class="reference internal" href="#examples-and-applications">Examples and Applications:</a></li>
<li><a class="reference internal" href="#fortran-and-python-codes">Fortran and Python codes:</a></li>
<li><a class="reference internal" href="#visclaw-plotting-and-visualization-tools">VisClaw: Plotting and Visualization Tools</a></li>
<li><a class="reference internal" href="#amrclaw-adaptive-mesh-refinement">AMRClaw: Adaptive Mesh Refinement</a></li>
<li><a class="reference internal" href="#geoclaw-for-geophysical-flows">GeoClaw: For geophysical flows</a></li>
<li><a class="reference internal" href="#pyclaw-python-tools">PyClaw: Python tools</a></li>
<li><a class="reference internal" href="#sharpclaw-high-order-methods">SharpClaw: High-order methods</a></li>
<li><a class="reference internal" href="#developers-resources">Developers’ resources</a></li>
<li><a class="reference internal" href="#bibliography">Bibliography</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="about.html" title="next chapter">About this software</a></li>
</ul></li>
</ul>
<div class="widget navlinks">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/contents.rst.txt"
rel="nofollow"
target="_blank">Source .rst</a></li>
<li><a href="https://github.com/clawpack/doc/blob/dev/doc/contents.rst"
rel="nofollow"
target="_blank">Source on GitHub</a></li>
<li><a href="https://github.com/clawpack/doc/commits/dev/doc/contents.rst"
rel="nofollow"
target="_blank">History</a></li>
<li><a href="https://github.com/clawpack/doc/edit/dev/doc/contents.rst"
rel="nofollow"
target="_blank">Suggest Edits</a></li>
<li><a href="https://github.com/clawpack/doc/issues/new/choose"
rel="nofollow"
target="_blank">Raise an Issue</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<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="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Latest Version</h4>
<ul>
<li><a href="../dev/contents.html">dev</a></li>
<li><a href="../v5.9.x/contents.html">v5.9.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="../v5.1.x/contents.html">v5.1.x</a></li>
<li><a href="contents.html">v5.2.x</a></li>
<li><a href="../v5.3.x/contents.html">v5.3.x</a></li>
<li><a href="../v5.4.x/contents.html">v5.4.x</a></li>
<li><a href="../v5.5.x/contents.html">v5.5.x</a></li>
<li><a href="../v5.6.x/contents.html">v5.6.x</a></li>
<li><a href="../v5.7.x/contents.html">v5.7.x</a></li>
<li><a href="../v5.8.x/contents.html">v5.8.x</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright CC-BY 2022, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44811544-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>