|
1 | 1 | This directory contains a few examples to get users started using |
2 | 2 | this software. In most directories you should be able to type: |
3 | 3 | make all |
4 | | -and the code should run and a set of plots produced. However, see the |
5 | | -individual README files in the directories. |
| 4 | +and the code should run and a set of plots produced. |
6 | 5 |
|
7 | | -The examples in this directory can also be used as regression tests. |
8 | | -Each example is run and the set of plots are then compared with those |
9 | | -archived in the gallery that can be found online in the documentation. |
10 | | -For this to work you need to first clone and/or |
11 | | -fetch a zip file of the latest gallery results from |
12 | | - git://github.com/clawpack/clawpack.github.com |
13 | | -Put this in the top $CLAW directory so that there is a subdirectory |
14 | | -$CLAW/clawpack.github.com. |
| 6 | +However, see the individual README files in the directories. |
15 | 7 |
|
16 | | -To run all tests: |
17 | | - python run_tests.py |
| 8 | +To run all examples in all subdirectories: |
| 9 | + python $CLAW/clawutil/src/python/clawutil/run_examples.py |
| 10 | +You might want to first check your environment variables, or you can set |
| 11 | +them explicitly by modifying the script. |
18 | 12 |
|
19 | | -It may take some time for these examples to all run. |
| 13 | +In addition to doing `make all`, this script also runs any Jupyter notebooks |
| 14 | +found in the subdirectories. |
| 15 | + |
| 16 | +It may take some time for these examples to all run. Two files |
| 17 | + make_all_output.txt |
| 18 | + make_all_errors.txt |
| 19 | +will be created that contain the output normally sent to the screen and any |
| 20 | +error messages from running the examples. |
20 | 21 |
|
21 | 22 | A quicker set of tests can be run from the classic/tests directory. See the |
22 | 23 | README file in that directory. |
|
0 commit comments