-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
513d7cf
commit b71a771
Showing
1 changed file
with
5 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,37 +4,22 @@ A high altitude balloon flight simulator based on [tkschuler/EarthSHAB](https:// | |
|
||
## Installation | ||
```sh | ||
cargo install --git https://github.com/Brickworks/yahs.git | ||
``` | ||
|
||
## Usage | ||
```sh | ||
export RUST_LOG=info # set the logging level [debug, info, warn] | ||
cargo install --git https://github.com/Brickworks/yahs.git --features gui | ||
yahs --help | ||
``` | ||
|
||
## Run a simulated flight | ||
### Configure the sim | ||
## Usage (CLI) | ||
Set the simulation configuration in `config/default.toml` | ||
|
||
### Start the sim | ||
Then use the `start` command to start a flight simulation. Use the `RUST_LOG` | ||
environment variable to specify the log level to report. | ||
|
||
```sh | ||
yahs start | ||
``` | ||
|
||
### View the flight data | ||
First install the Brickworks support tooling, `firebrick`. | ||
```sh | ||
git clone [email protected]:Brickworks/firebrick.git | ||
cd firebrick | ||
pip install . | ||
## Usage (GUI) | ||
|
||
firebrick --help | ||
``` | ||
Then start up a telemetry dashboard. | ||
```sh | ||
firebrick dashboard -t $PATH_TO_TELEMETRY_CSV | ||
yahs gui | ||
``` | ||
Then navigate to the server address specified in the log output. |