Update README.md
formatting readme file
1 changed file+13−11
README.mdmodified+13−11View file
@@ -6,14 +6,16 @@
66 This project requires [Matlab](https://www.mathworks.com/help/install/ug/install-products-with-internet-connection.html)
77 and [finufft](https://github.com/flatironinstitute/finufft.git).
88
9-## Example runs
10-Enter experiment number (expNum) in the driver file main.m to run built-in examples.
11-Parameters for example runs are found in get_experimentParameters(expNum):
12-expNum = 1, interpolation order 3 manufactured solution convergence study with 10 randomly located sources in [-2,2] up to time 3*pi
13-expNum = 2, interpolation order 8 scattering from 150 springs located randomly on [-2,2] up to time 10*pi
14-expNum = 3, interpolation order 8 scattering from 1000 springs located randomly on [-2,2] up to time 3*pi with narrow incident wave
15-expNum = 4, interpolation order 8 scattering from 10000 springs located randomly on [-2,2] up to time 3*pi with narrow incident wave
16-expNum = 5, interpolation order 8 scattering from 2 stiff springs located on -0.5 and 0.5 up to time 30*pi with wide incident wave to simulate Fabry-Perot interferometer
17-expNum = 6, interpolation order 8 scattering from 10 stiff springs located uniformly between -2 to 2 up to time 40*pi final time with wide incident wave
18-expNum = 7, interpolation order 8 scattering from 200 springs located uniformly between -2 to 2 up to time 40*pi final time with wide incident wave
19-expNum = 999, experiment number reserved for running tests and debugging
9+## Running Built-in Examples
10+
11+Enter the experiment number (`expNum`) in the driver file `main.m` to run built-in examples.
12+Parameters for example runs are found in `get_experimentParameters(expNum)`:
13+
14+- `expNum = 1`: Interpolation order 3 — manufactured solution convergence study with 10 randomly located sources in `[-2, 2]`, up to time `3π`.
15+- `expNum = 2`: Interpolation order 8 — scattering from 150 springs located randomly on `[-2, 2]`, up to time `10π`.
16+- `expNum = 3`: Interpolation order 8 — scattering from 1000 springs located randomly on `[-2, 2]`, up to time `3π` with narrow incident wave.
17+- `expNum = 4`: Interpolation order 8 — scattering from 10000 springs located randomly on `[-2, 2]`, up to time `3π` with narrow incident wave.
18+- `expNum = 5`: Interpolation order 8 — scattering from 2 stiff springs located at `-0.5` and `0.5`, up to time `30π` with wide incident wave (simulates Fabry-Perot interferometer).
19+- `expNum = 6`: Interpolation order 8 — scattering from 10 stiff springs located uniformly between `-2` to `2`, up to time `40π` with wide incident wave.
20+- `expNum = 7`: Interpolation order 8 — scattering from 200 springs located uniformly between `-2` to `2`, up to time `40π` with wide incident wave.
21+- `expNum = 999`: Reserved for running tests and debugging.