Skip to content

Commit

Permalink
Reword the README a little
Browse files Browse the repository at this point in the history
  • Loading branch information
mfitz committed Mar 19, 2024
1 parent b1cb49d commit 8876969
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ of the transport Key Performance Indicators (KPI) framework described at
understand and explore the framework, and as such, should be regarded as a by-product of the framework rather
than a work in its own right.

The KPI metrics generated by Gelato provide a snapshot summary of a
given MATSim model, and help compare different MATSim models and scenarios against each other.
The KPI metrics generated by Gelato provide a snapshot summary of a given MATSim model, and help compare different
MATSim models and scenarios against each other.


# Installation
Expand Down Expand Up @@ -79,7 +79,7 @@ drwxr-xr-x@ 15 mickyfitz staff 480B 13 Dec 15:17 ..

# Usage

You can run Gelato from the command line, directly from the jar file. The CLI is quite discoverable:
You can run Gelato from the command line, directly from the jar file. The CLI is discoverable:

```shell
java -jar target/gelato-0.0.1-alpha-with-dependencies-230f897.jar --help
Expand Down Expand Up @@ -112,7 +112,9 @@ java -jar target/gelato-0.0.1-alpha-with-dependencies-230f897.jar \
```

We recommend using MATSim's output config file for the `-mc` parameter wherever
possible.
possible, because output config files have been validated by MATSim and used
successfully to run a simulation. As such, they are slightly "safer" to use
than "input" config files.

Gelato will read in MATSim's output files and generate a number of compressed output
files in the directory you specified via `-o`, giving you something like this:
Expand Down

0 comments on commit 8876969

Please sign in to comment.