Skip to content

Commit

Permalink
docs: update readme with instructions on running the simulation
Browse files Browse the repository at this point in the history
  • Loading branch information
okjodom committed Nov 17, 2023
1 parent ef0a686 commit 9975d8a
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,14 @@ Install the CLI:
cargo install --locked --path sim-cli/
```

Run with Simulation File (see [setup instructions](#simulation-file-setup) for details):
```
sim-cli sim.json
To run the simulation, create a simulation file `sim.json` in the working directory (see [setup instructions](#simulation-file-setup) for details) and run:

```
sim-cli
```

Run `sim-cli -h` for details on `--data-dir` and `--sim-file` options that allow specifying custom simulation file locations.

### Simulation File Setup
The simulator requires access details for a set of `nodes` that you
have permission to execute commands on. Note that the current version
Expand Down Expand Up @@ -190,10 +193,12 @@ described above). Activity sources and destinations may reference the
*must* provide a valid public key.

### Simulation Output
A summary of the results will be logged by the simulator, and a full
list of payments made with their outcomes is available in
`simulation_{timestamp}.csv` in the directory that the simulation was
executed in. For more detailed logs, use the `--log-level` cli flag.

A summary of the results will be logged by the simulator. A full list of payments made with their outcomes
is available in `simulation_{timestamp}.csv` within the configured `{data_dir}/results`.

Run `sim-cli -h` for details on data directory (`--data-dir`) and other options including `--print-batch-size`
which affect how simulation outputs are persisted

## Lightning Environments
If you're looking to get started with local lightning development, we
Expand Down

0 comments on commit 9975d8a

Please sign in to comment.