-
Notifications
You must be signed in to change notification settings - Fork 7
/
apps.html
249 lines (236 loc) · 11.7 KB
/
apps.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
<!DOCTYPE html>
<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>Clawpack Applications repository — 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" />
<link rel="stylesheet" type="text/css" href="_static/flasky.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<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/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" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Clawpack Gallery" href="galleries.html" />
<link rel="prev" title="Amazon Web Services EC2 Clawpack AMI" href="aws.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="contents.html">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="galleries.html" title="Clawpack Gallery"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="aws.html" title="Amazon Web Services EC2 Clawpack AMI"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.10.x documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Clawpack Applications repository</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="clawpack-applications-repository">
<span id="apps"></span><h1>Clawpack Applications repository<a class="headerlink" href="#clawpack-applications-repository" title="Permalink to this heading">¶</a></h1>
<p>More complex examples and applications are archived in the Github
<cite>clawpack/apps</cite> repository found at
<a class="reference external" href="https://github.com/clawpack/apps">https://github.com/clawpack/apps</a>.</p>
<p>In particular, the directory <cite>apps/fvmbook</cite> contains many <a class="reference internal" href="fvmbook.html#fvmbook"><span class="std std-ref">Examples from the book FVMHP</span></a>.</p>
<p>The <a class="reference external" href="http://www.clawpack.org/gallery/index.html">Clawpack Gallery</a>
shows results/animations from some selected examples in the <cite>apps</cite> repository.</p>
<p>These examples are not included in the basic Clawpack installation.
Users interested in obtaining this collection of applications can either
clone the repository using git:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">clawpack</span><span class="o">/</span><span class="n">apps</span>
</pre></div>
</div>
<p>or navigate to <a class="reference external" href="https://github.com/clawpack/apps">https://github.com/clawpack/apps</a>
and click on the green “Code” button to see other options, such as downloading
a zip file.</p>
<section id="jupyter-notebooks">
<h2>Jupyter Notebooks<a class="headerlink" href="#jupyter-notebooks" title="Permalink to this heading">¶</a></h2>
<p>The directory <cite>apps/notebooks</cite> contains a number of notebooks that illustrate
various aspects of Clawpack. Many of these are also visible in rendered html
form in the
<a class="reference external" href="http://www.clawpack.org/gallery/notebooks.html">Gallery of Notebooks</a>.</p>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading">¶</a></h2>
<p>The <cite>apps</cite> repository contains several
<a class="reference external" href="https://git-scm.com/book/en/v2/Git-Tools-Submodules">git submodules</a>
for collections of examples specific to some application.
This has the advantage that the submodules can be managed independent of the
main <cite>apps</cite> repository, perhaps by people who are not core Clawpack
developers. (Contact us if you have a repository of examples you would like
to see added.)
Also each submodule may be of limited interest, and could contain some large
files that not every Clawpack user wants to download.</p>
<p>For example, after cloning the <cite>apps</cite> repository you will see a subdirectory
for storm surge modeling examples using GeoClaw named
<cite>apps/surge-examples</cite>, which initially is an empty directory. The file
<cite>apps/.gitmodules</cite> shows that this is a submodule.
It also shows the url to the GitHub repository corresponding to this module
(where you could do a pull request, for example, if you find a bug).</p>
<p>If you want to add only the <cite>surge-examples</cite>, and not other submodules,
you can do:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">submodule</span> <span class="n">update</span> <span class="o">--</span><span class="n">init</span> <span class="n">surge</span><span class="o">-</span><span class="n">examples</span>
</pre></div>
</div>
<p>If you want to add all available submodules, leave off the submodule name:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">submodule</span> <span class="n">update</span> <span class="o">--</span><span class="n">init</span>
</pre></div>
</div>
<p>The <cite>–init</cite> flag is not needed (but won’t hurt) if you are updating
a submodule that you have already initialized and cloned, e.g. if
the submodule maintainer has added new examples to it.</p>
</section>
<section id="examples-included-with-clawpack">
<h2>Examples included with Clawpack<a class="headerlink" href="#examples-included-with-clawpack" title="Permalink to this heading">¶</a></h2>
<p>Recall also that a few examples of how to use different flavors of
Clawpack are included in every distribution of Clawpack, in the directories</p>
<ul class="simple">
<li><p><cite>$CLAW/classic/examples</cite></p></li>
<li><p><cite>$CLAW/amrclaw/examples</cite></p></li>
<li><p><cite>$CLAW/geoclaw/examples</cite></p></li>
<li><p><cite>$CLAW/pyclaw/examples</cite></p></li>
</ul>
<p>These examples demonstrate some of the basic capabilities.
The plots resulting from running these examples should agree with those seen
in the <a class="reference external" href="http://www.clawpack.org/gallery/index.html">Clawpack Gallery</a>.</p>
</section>
</section>
<div class="clearer"></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.10.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Clawpack Applications repository</a><ul>
<li><a class="reference internal" href="#jupyter-notebooks">Jupyter Notebooks</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#examples-included-with-clawpack">Examples included with Clawpack</a></li>
</ul>
</li>
</ul>
</div><h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li>Previous: <a href="aws.html" title="previous chapter">Amazon Web Services EC2 Clawpack AMI</a></li>
<li>Next: <a href="galleries.html" title="next chapter">Clawpack Gallery</a></li>
</ul></li>
</ul>
<div class="widget navlinks">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/apps.rst.txt"
rel="nofollow"
target="_blank">Source .rst</a></li>
<li><a href="https://github.com/clawpack/doc/blob/dev/doc/apps.rst"
rel="nofollow"
target="_blank">Source on GitHub</a></li>
<li><a href="https://github.com/clawpack/doc/commits/dev/doc/apps.rst"
rel="nofollow"
target="_blank">History</a></li>
<li><a href="https://github.com/clawpack/doc/edit/dev/doc/apps.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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/apps.html">dev</a></li>
<li><a href="apps.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.7.x/apps.html">v5.7.x</a></li>
<li><a href="./v5.8.x/apps.html">v5.8.x</a></li>
<li><a href="./v5.9.x/apps.html">v5.9.x</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright CC-BY 2024, 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>