PageRenderTime 65ms CodeModel.GetById 33ms RepoModel.GetById 0ms app.codeStats 0ms

/v5.5.x/first_run.html

https://github.com/clawpack/clawpack.github.com
HTML | 268 lines | 256 code | 11 blank | 1 comment | 0 complexity | 78229a2b4d0dcb76ed2644d583d0f0bd MD5 | raw file
    

  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. <html xmlns="http://www.w3.org/1999/xhtml">
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8" />
    7. 

  7.     <title>Running an example &#8212; Clawpack 5.5.0 documentation</title>
    8. 

  8.     <link rel="stylesheet" href="_static/flasky.css" type="text/css" />
    9. 

  9.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="_static/base.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="_static/layout.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
    13. 

  13.     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    14. 

  14.     <script src="_static/jquery.js"></script>
    15. 

  15.     <script src="_static/underscore.js"></script>
    16. 

  16.     <script src="_static/doctools.js"></script>
    17. 

  17.     <script src="_static/language_data.js"></script>
    18. 

  18.     <script async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    19. 

  19.     <link rel="shortcut icon" href="_static/clawicon.ico"/>
    20. 

  20.     <link rel="author" title="About these documents" href="about.html" />
    21. 

  21.     <link rel="index" title="Index" href="genindex.html" />
    22. 

  22.     <link rel="search" title="Search" href="search.html" />
    23. 

  23.     <link rel="next" title="Clawpack components" href="clawpack_components.html" />
    24. 

  24.     <link rel="prev" title="Set environment variables" href="setenv.html" /> 
    25. 

  25.   </head><body>
    26. 

  26. <div id="main-wrapper" class="sphinx">
    27. 

  27. <div id="header-wrapper">
    28. 

  28.   <section id="header">
    29. 

  29.     <!-- <h1><a href="http://clawpack.org/">Clawpack</a></h1> -->
    30. 

  30.     <h1><a href="http://clawpack.org/">Clawpack-5</a></h1> 
    31. 

  31.     <nav>
    32. 

  32.       <ul>
    33. 

  33.         <li>
    34. 

  34.           <a href="contents.html">Docs</a>
    35. 

  35.         </li>
    36. 

  36.         <li>
    37. 

  37.           <a href="installing.html">Install</a>
    38. 

  38.         </li>
    39. 

  39.         <li>
    40. 

  40.           <a class="" href="http://clawpack.org/gallery/index.html">Gallery</a>
    41. 

  41.         </li>
    42. 

  42.         <li>
    43. 

  43.           <a href="about.html">Citation</a>
    44. 

  44.         </li>
    45. 

  45.         <li>
    46. 

  46.           <a class="active" href="http://github.com/clawpack">GitHub</a>
    47. 

  47.         </li>
    48. 

  48.         <li>
    49. 

  49.           <a class="" href="community.html">Community</a>
    50. 

  50.         </li>
    51. 

  51.         <li>
    52. 

  52.           <a class="" href="developers.html">Contribute</a>
    53. 

  53.         </li>
    54. 

  54.       </ul>
    55. 

  55.     </nav>
    56. 

  56.   </section>
    57. 

  57. <div class="decoration"></div>
    58. 

  58. </div>
    59. 

  59. 

  60.     <div class="related" role="navigation" aria-label="related navigation">
    61. 

  61.       <h3>Navigation</h3>
    62. 

  62.       <ul>
    63. 

  63.         <li class="right" style="margin-right: 10px">
    64. 

  64.           <a href="genindex.html" title="General Index"
    65. 

  65.              accesskey="I">index</a></li>
    66. 

  66.         <li class="right" >
    67. 

  67.           <a href="py-modindex.html" title="Python Module Index"
    68. 

  68.              >modules</a> |</li>
    69. 

  69.         <li class="right" >
    70. 

  70.           <a href="clawpack_components.html" title="Clawpack components"
    71. 

  71.              accesskey="N">next</a> |</li>
    72. 

  72.         <li class="right" >
    73. 

  73.           <a href="setenv.html" title="Set environment variables"
    74. 

  74.              accesskey="P">previous</a> |</li>
    75. 

  75.         <li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.5.0 documentation</a> &#187;</li> 
    76. 

  76.       </ul>
    77. 

  77.     </div>  
    78. 

  78. 

  79.     <div class="document">
    80. 

  80.       <div class="documentwrapper">
    81. 

  81.         <div class="bodywrapper">
    82. 

  82.           <div class="body" role="main">
    83. 

  83.             
    84. 

  84.   <div class="section" id="running-an-example">
    85. 

  85. <span id="first-run"></span><h1>Running an example<a class="headerlink" href="#running-an-example" title="Permalink to this headline"></a></h1>
    86. 

  86. <p>Many examples of Clawpack simulations can be seen in the <span class="xref std std-ref">galleries</span>.</p>
    87. 

  87. <p>See also <span class="xref std std-ref">first_tests</span>.</p>
    88. 

  88. <div class="section" id="pyclaw">
    89. 

  89. <h2>PyClaw<a class="headerlink" href="#pyclaw" title="Permalink to this headline"></a></h2>
    90. 

  90. <p>To run an example and plot the results using PyClaw, simply do the following
    91. 

  91. (starting from your <cite>clawpack</cite> directory):</p>
    92. 

  92. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">pyclaw</span><span class="o">/</span><span class="n">examples</span><span class="o">/</span><span class="n">euler_2d</span>
    93. 

  93. <span class="n">python</span> <span class="n">shock_bubble_interaction</span><span class="o">.</span><span class="n">py</span> <span class="n">iplot</span><span class="o">=</span><span class="mi">1</span>
    94. 

  94. </pre></div>
    95. 

  95. </div>
    96. 

  96. <p>That’s it.  For next steps with PyClaw, see <a class="reference internal" href="pyclaw/basics.html#basics"><span class="std std-ref">PyClaw Basics</span></a>.</p>
    97. 

  97. </div>
    98. 

  98. <div class="section" id="classic">
    99. 

  99. <h2>Classic<a class="headerlink" href="#classic" title="Permalink to this headline"></a></h2>
    100. 

  100. <p>First ensure that you have <a class="reference internal" href="setenv.html#setenv"><span class="std std-ref">Set environment variables</span></a>
    101. 

  101. and that you have the <span class="xref std std-ref">install_prerequisites</span>.</p>
    102. 

  102. <p>A simple 1-dimensional acoustics equations can be solved
    103. 

  103. using the code in <a class="reference external" href="_static/classic/examples/acoustics_1d_example1/README.html">$CLAW/classic/examples/acoustics_1d_example1</a>, as
    104. 

  104. illustrated in <span class="xref std std-ref">gallery_classic_amrclaw</span>.</p>
    105. 

  105. <p>Move to this directory via:</p>
    106. 

  106. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>cd $CLAW/classic/examples/acoustics_1d_example1
    107. 

  107. </pre></div>
    108. 

  108. </div>
    109. 

  109. <p>You can try the following test in this directory, or you may want to first
    110. 

  110. make a copy of it (see the instructions in <a class="reference internal" href="newapp.html#copyex"><span class="std std-ref">Copying an existing example</span></a>).</p>
    111. 

  111. <p>The Makefiles are set up to do dependency checking so that in many
    112. 

  112. application directories you can simply type:</p>
    113. 

  113. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make .plots
    114. 

  114. </pre></div>
    115. 

  115. </div>
    116. 

  116. <p>and the Fortran code will be compiled, data files created, the code
    117. 

  117. run, and the results plotted automatically, resulting in a set of webpages
    118. 

  118. showing the results.</p>
    119. 

  119. <p>However, if this is your first attempt to run a code, it is useful to go
    120. 

  120. through these steps one at a time, both to understand the steps and so that
    121. 

  121. any problems with your installation can be properly identified.</p>
    122. 

  122. <p>You might want to start by examining the Makefile.  This sets a number of
    123. 

  123. variables, which at some point you might need to modify for other examples,
    124. 

  124. see <a class="reference internal" href="makefiles.html#makefiles"><span class="std std-ref">Clawpack Makefiles</span></a> for more about this.  At the bottom of the Makefile is
    125. 

  125. an <cite>include</cite> statement that points to a common Makefile that is used by most
    126. 

  126. applications, and where all the details of the make process can be found.</p>
    127. 

  127. <p>To compile the code, type:</p>
    128. 

  128. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make .exe
    129. 

  129. </pre></div>
    130. 

  130. </div>
    131. 

  131. <p>If this gives an error, see <a class="reference internal" href="trouble.html#trouble-makeexe"><span class="std std-ref">Trouble running “make .exe”</span></a>.</p>
    132. 

  132. <p>This should compile the example code (after first compiling the required
    133. 

  133. library routines) and produce an executable named <cite>xclaw</cite> in this directory.</p>
    134. 

  134. <p>Before running the code, it is necessary to also create a set of data files
    135. 

  135. that are read in by the Fortran code.  This can be done via:</p>
    136. 

  136. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make .data
    137. 

  137. </pre></div>
    138. 

  138. </div>
    139. 

  139. <p>If this gives an error, see <a class="reference internal" href="trouble.html#trouble-makedata"><span class="std std-ref">Trouble running “make .data”</span></a>.</p>
    140. 

  140. <p>This uses the Python code in <cite>setrun.py</cite> to create data files that have the
    141. 

  141. form <cite>*.data</cite>.</p>
    142. 

  142. <p>Once the executable and the data files all exist, we can run the code.  The
    143. 

  143. recommended way to do this is to type:</p>
    144. 

  144. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make .output
    145. 

  145. </pre></div>
    146. 

  146. </div>
    147. 

  147. <p>If this gives an error, see <a class="reference internal" href="trouble.html#trouble-makeoutput"><span class="std std-ref">Trouble running “make .output”</span></a>.</p>
    148. 

  148. <p>Before running the code a subdirectory <cite>_output</cite> is created
    149. 

  149. and the output of the code (often a large number of files) is directed to
    150. 

  150. this subdirectory.  This is convenient if you want to do several runs with
    151. 

  151. different parameter values and keep the results organized.  After the code
    152. 

  152. has run you can rename the subdirectory, or you can modify the variable
    153. 

  153. <cite>OUTDIR</cite> in the Makefile to direct results to a different directory.  See
    154. 

  154. <a class="reference internal" href="makefiles.html#makefiles"><span class="std std-ref">Clawpack Makefiles</span></a> for more details.  Copies of all the data files are also
    155. 

  155. placed in the output directory for future reference.</p>
    156. 

  156. <p><strong>Plotting the results.</strong>
    157. 

  157. Once the code has run and the files listed above have been created, there are several
    158. 

  158. options for plotting the results.</p>
    159. 

  159. <p>To try the Python tools, type:</p>
    160. 

  160. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make .plots
    161. 

  161. </pre></div>
    162. 

  162. </div>
    163. 

  163. <p>If this gives an error, see <a class="reference internal" href="trouble.html#trouble-makeplots"><span class="std std-ref">Trouble running “make .plots”</span></a>.</p>
    164. 

  164. <p>If this works, it will create a subdirectory named <cite>_plots</cite> that contains a number of
    165. 

  165. image files (the <cite>*.png</cite> files) and a set of html files that can be used to view the
    166. 

  166. results from a web browser.  See <span class="xref std std-ref">plotting_makeplots</span> for more details.</p>
    167. 

  167. <p>An alternative is to view the plots from an interactive Python session, as described in
    168. 

  168. the section <a class="reference internal" href="plotting_python.html#plotting-iplotclaw"><span class="std std-ref">Interactive plotting with Iplotclaw</span></a>.</p>
    169. 

  169. <p>If you wish to use Matlab instead, see <a class="reference internal" href="matlab_plotting.html#matlabplots"><span class="std std-ref">Plotting using Matlab</span></a>.</p>
    170. 

  170. <p>Other visualization packages could also be used to display the results, but you will need
    171. 

  171. to figure out how to read in the data.  See <span class="xref std std-ref">fortfiles</span> for information about the
    172. 

  172. format of the files produced by Clawpack.</p>
    173. 

  173. </div>
    174. 

  174. </div>
    175. 

  175. 

  176. 

  177.           </div>
    178. 

  178.         </div>
    179. 

  179.       </div>
    180. 

  180.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    181. 

  181.         <div class="sphinxsidebarwrapper">
    182. 

  182. <p><a href="http://clawpack.org/">
    183. 

  183.     <img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
    184. 

  184. </a>
    185. 

  185. <h2>Version 5.5.0</h2>
    186. 

  186. </p>
    187. 

  187.   <h3><a href="contents.html">Table of Contents</a></h3>
    188. 

  188.   <ul>
    189. 

  189. <li><a class="reference internal" href="#">Running an example</a><ul>
    190. 

  190. <li><a class="reference internal" href="#pyclaw">PyClaw</a></li>
    191. 

  191. <li><a class="reference internal" href="#classic">Classic</a></li>
    192. 

  192. </ul>
    193. 

  193. </li>
    194. 

  194. </ul>
    195. 

  195. <h3>Related Topics</h3>
    196. 

  196. <ul>
    197. 

  197.   <li><a href="contents.html">Documentation overview</a><ul>
    198. 

  198.       <li>Previous: <a href="setenv.html" title="previous chapter">Set environment variables</a></li>
    199. 

  199.       <li>Next: <a href="clawpack_components.html" title="next chapter">Clawpack components</a></li>
    200. 

  200.   </ul></li>
    201. 

  201. </ul>
    202. 

  202. <div class="widget navlinks">
    203. 

  203.   <h3>This Page</h3>
    204. 

  204.   <ul class="this-page-menu">
    205. 

  205.     <li><a href="_sources/first_run.rst.txt"
    206. 

  206.             rel="nofollow"
    207. 

  207.             target="_blank">Source .rst</a></li>
    208. 

  208.     <li><a href="https://github.com/clawpack/doc/blob/dev/doc/first_run.rst"
    209. 

  209.             rel="nofollow"
    210. 

  210.             target="_blank">Source on GitHub</a></li>
    211. 

  211.      <li><a href="https://github.com/clawpack/doc/commits/dev/doc/first_run.rst"
    212. 

  212.              rel="nofollow"
    213. 

  213.              target="_blank">History</a></li>
    214. 

  214.     <li><a href="https://github.com/clawpack/doc/edit/dev/doc/first_run.rst"
    215. 

  215.             rel="nofollow"
    216. 

  216.             target="_blank">Suggest Edits</a></li>
    217. 

  217.      <li><a href="https://github.com/clawpack/doc/issues/new/choose"
    218. 

  218.              rel="nofollow"
    219. 

  219.              target="_blank">Raise an Issue</a></li>
    220. 

  220.   </ul>
    221. 

  221. </div>
    222. 

  222. <div id="searchbox" style="display: none" role="search">
    223. 

  223.   <h3 id="searchlabel">Quick search</h3>
    224. 

  224.     <div class="searchformwrapper">
    225. 

  225.     <form class="search" action="search.html" method="get">
    226. 

  226.       <input type="text" name="q" aria-labelledby="searchlabel" />
    227. 

  227.       <input type="submit" value="Go" />
    228. 

  228.     </form>
    229. 

  229.     </div>
    230. 

  230. </div>
    231. 

  231. <script>$('#searchbox').show(0);</script>
    232. 

  232. <h4>Latest Version</h4>
    233. 

  233. <ul>
    234. 

  234.   <li><a href="../dev/first_run.html">dev</a></li>
    235. 

  235.   <li><a href="../v5.8.x/first_run.html">v5.8.x</a></li>
    236. 

  236. </ul>
    237. 

  237. <h4>Older Versions</h4>
    238. 

  238. <ul>
    239. 

  239.   <li><a href="../v5.1.x/first_run.html">v5.1.x</a></li>
    240. 

  240.   <li><a href="../v5.2.x/first_run.html">v5.2.x</a></li>
    241. 

  241.   <li><a href="../v5.3.x/first_run.html">v5.3.x</a></li>
    242. 

  242.   <li><a href="../v5.4.x/first_run.html">v5.4.x</a></li>
    243. 

  243.   <li><a href="first_run.html">v5.5.x</a></li>
    244. 

  244.   <li><a href="../v5.6.x/first_run.html">v5.6.x</a></li>
    245. 

  245.   <li><a href="../v5.7.x/first_run.html">v5.7.x</a></li>
    246. 

  246. </ul>
    247. 

  247. 

  248.         </div>
    249. 

  249.       </div>
    250. 

  250.       <div class="clearer"></div>
    251. 

  251.     </div>
    252. 

  252.   <div class="footer">
    253. 

  253.     &copy; Copyright CC-BY 2020, The Clawpack Development Team.
    254. 

  254.     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
    255. 

  255.   </div>
    256. 

  256.   <script>
    257. 

  257.   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    258. 

  258.   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
    259. 

  259.   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    260. 

  260.   })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
    261. 

  261. 

  262.   ga('create', 'UA-44811544-1', 'auto');
    263. 

  263.   ga('send', 'pageview');
    264. 

  264. 

  265.   </script>
    266. 

  266.   
    267. 

  267.   </body>
    268. 

  268. </html>
    269.