Commit e8000b38 authored by Sebastian Heimann's avatar Sebastian Heimann
Browse files

fix text formatting in readme

parent 7887698d
......@@ -21,12 +21,12 @@ sudo python setup.py install
Grond can be run as a command line tool or by calling Grond's library functions
from a Python script. To get a brief description on available options of
Grond's command line tool, run `grond --help` or `grond <subcommand> --help`.
Once dataset and configuration are ready, the command `grond go <configfile>
<eventname>` starts the optimization algorithm for a selected event. During the
optimization, results are aggregated in a directory, referred to in the
configuration as `<rundir>`. To visualize the results run `grond plot
<plotnames> <rundir>`. The results can be exported in various way by running
the subcommand `grond export <what> <rundir>`.
Once dataset and configuration are ready, the command
`grond go <configfile> <eventname>` starts the optimization algorithm for a
selected event. During the optimization, results are aggregated in a directory,
referred to in the configuration as `<rundir>`. To visualize the results run
`grond plot <plotnames> <rundir>`. The results can be exported in various way
by running the subcommand `grond export <what> <rundir>`.
## Example configuration file
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment