Skip to content

Commit

Permalink
Added notes on save raw data, plotting options and path info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
tinybike committed Aug 10, 2015
1 parent 31f3f12 commit a9a18c0
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ Run simulations with default settings using all available cores:

$ julia -p `nproc` test/controller.jl

To run unit tests:
Simulation results are automatically saved to `test/data`. If `sim.SAVE_RAW_DATA = true`, in addition to the output data, full time traces will be saved to `test/data/raw`. (Caution: this option both slows down the simulations and requires considerable storage space to store the results.)

Augur.jl includes plotters written for PyPlot and Gadfly. To generate plots, just specify `pyplot` or `gadfly` when you run the simulations:

$ julia -p `nproc` test/controller.jl pyplot

Plots are saved to `test/plots`.

### Tests

Unit tests are included with Augur.jl, and can be run from the `test/runtests.jl` script:

$ julia test/runtests.jl

0 comments on commit a9a18c0

Please sign in to comment.