Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adding more usage documentation to README to address #18.
  • Loading branch information
tkoskela committed Apr 3, 2020
1 parent f30ec43 commit a920c86
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,29 @@ with
using TDAC
```

To run the simulation using default parameters, call the main function with no arguments

```julia
TDAC.tdac()
```

Note that with the default parameters, no output is produced. The default parameters can be
found in the file [parameters.jl](https://github.com/Team-RADDISH/TDAC.jl/blob/master/src/params.jl).
The parameter `verbose` is set to `false` to suppress the output. If `verbose` is set to `true`,
the code will produce two ascii files in the `out/` directory. The file `jl-syn__XXXXXX__.dat`
contains the true state vector at time step XXXXXX. The file `jl-da__XXXXXX__.dat` contains the
average state vector of all particles in the simualtion.

To change parameters from the defaults, create a text file, and pass the path to it as an argument

```julia
TDAC.tdac("path/to/my/input/file")
```

The input file is in the yaml format. Each row contains `<parameter name> : <parameter value>`.
For an example input file, see the [input file for the first integration test](https://github.com/Team-RADDISH/TDAC.jl/blob/master/test/integration_test_1.yaml).
Any parameters not specified in the input file will retain their default values.

## Testing

We have a basic test suite for `TDAC.jl`. You can run the tests by entering the
Expand Down

0 comments on commit a920c86

Please sign in to comment.