-
Notifications
You must be signed in to change notification settings - Fork 7
/
clawpack_components.html
216 lines (203 loc) · 9.96 KB
/
clawpack_components.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
<!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 components — 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="Wave-propagation algorithms" href="wp_algorithms.html" />
<link rel="prev" title="Running an example" href="first_run.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="wp_algorithms.html" title="Wave-propagation algorithms"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="first_run.html" title="Running an example"
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 components</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="clawpack-components">
<span id="id1"></span><h1>Clawpack components<a class="headerlink" href="#clawpack-components" title="Permalink to this heading">¶</a></h1>
<p>Clawpack is developed using the <a class="reference external" href="http://git-scm.com/">git</a> version control
system and all the source code is openly available via the
<a class="reference external" href="https://github.com/orgs/clawpack">Clawpack GitHub Organization</a>.</p>
<p>The code is organized in several independent git repositories. One of these
is the <a class="reference external" href="https://github.com/clawpack/clawpack">clawpack/clawpack</a>
super-repository that is used to coordinate versions between other
repositories. If you are interested in cloning the code directly from
GitHub and/or helping develop Clawpack, see <a class="reference internal" href="developers.html#developers"><span class="std std-ref">Developers’ Guide</span></a>.</p>
<p>After installing Clawpack, you should have a top level directory that has the
following subdirectories:</p>
<ul class="simple">
<li><p><cite>classic</cite> (Classic single-grid Fortran code)</p></li>
<li><p><cite>amrclaw</cite> (<a class="reference internal" href="amrclaw.html#amrclaw"><span class="std std-ref">AMRClaw Description and Detailed Contents</span></a>, AMR version of Fortran code)</p></li>
<li><p><cite>riemann</cite> (<a class="reference internal" href="riemann.html#riemann"><span class="std std-ref">Riemann solvers</span></a>, in Fortran, also used by PyClaw)</p></li>
<li><p><cite>geoclaw</cite> (<a class="reference internal" href="geoclaw.html#geoclaw"><span class="std std-ref">GeoClaw Description and Detailed Contents</span></a> for geophysical flows)</p></li>
<li><p><cite>clawutil</cite> (Utility functions, Makefile.common used in multiple repositories)</p></li>
<li><p><cite>pyclaw</cite> (<span class="xref std std-ref">pyclaw/index</span>, Python version that includes SharpClaw and PETSc parallelization)</p></li>
<li><p><cite>visclaw</cite> (Python graphics and visualization tools)</p></li>
</ul>
<p>These correspond to individual GitHub repositories in the
<a class="reference external" href="https://github.com/orgs/clawpack">Clawpack GitHub Organization</a>.</p>
<section id="other-repositories">
<span id="other-repos"></span><h2>Other repositories<a class="headerlink" href="#other-repositories" title="Permalink to this heading">¶</a></h2>
<p>Other repositories in the
<a class="reference external" href="https://github.com/orgs/clawpack">Clawpack GitHub Organization</a>
may be of interest to some users:</p>
<ul class="simple">
<li><p><cite>apps</cite> contains additional applications, see <a class="reference internal" href="apps.html#apps"><span class="std std-ref">Clawpack Applications repository</span></a>.</p></li>
<li><p><cite>doc</cite> contains <a class="reference external" href="http://sphinx.pocoo.org/">sphinx</a> input files for the
Clawpack documentation, see <a class="reference internal" href="howto_doc.html#howto-doc"><span class="std std-ref">Guide for updating this documentation</span></a></p></li>
<li><p><cite>clawpack.github.com</cite> contains the html files that appear on the web.</p></li>
<li><p><cite>clawpack-4.x</cite> contains the latest version of
<a class="reference external" href="http://depts.washington.edu/clawpack">Clawpack 4.x</a>, the legacy code.</p></li>
</ul>
</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 components</a><ul>
<li><a class="reference internal" href="#other-repositories">Other repositories</a></li>
</ul>
</li>
</ul>
</div><h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li>Previous: <a href="first_run.html" title="previous chapter">Running an example</a></li>
<li>Next: <a href="wp_algorithms.html" title="next chapter">Wave-propagation algorithms</a></li>
</ul></li>
</ul>
<div class="widget navlinks">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/clawpack_components.rst.txt"
rel="nofollow"
target="_blank">Source .rst</a></li>
<li><a href="https://github.com/clawpack/doc/blob/dev/doc/clawpack_components.rst"
rel="nofollow"
target="_blank">Source on GitHub</a></li>
<li><a href="https://github.com/clawpack/doc/commits/dev/doc/clawpack_components.rst"
rel="nofollow"
target="_blank">History</a></li>
<li><a href="https://github.com/clawpack/doc/edit/dev/doc/clawpack_components.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/clawpack_components.html">dev</a></li>
<li><a href="clawpack_components.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.7.x/clawpack_components.html">v5.7.x</a></li>
<li><a href="./v5.8.x/clawpack_components.html">v5.8.x</a></li>
<li><a href="./v5.9.x/clawpack_components.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>