Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
superextinct authored Jul 15, 2020
1 parent 5788a18 commit 16eb46b
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
# tripper
Convert data from SharedStreet's trip-simulator into Kepler.gl input

## Installation
Clone the repo and install with `npm install`

## Usage
### 1. Generate Trips
Generate GPS Temeletry with [trip-simulator](https://github.com/sharedstreets/trip-simulator). For detailed explanation see [Use](https://github.com/sharedstreets/trip-simulator#use).

```
trip-simulator \
--config scooter \
--pbf nash.osm.pbf \
--graph nash.osrm \
--agents 100 \
--start 1563122921000 \
--seconds 86400 \
--traces ./traces.json \
--probes ./probes.json \
--changes ./changes.json \
--trips ./trips.json
```

### 2. Convert simulated trips with tripper
Run tripper with `trips.json` as input file and specify an output filepath:

```
node tripper --input="./trips.json" --output="./parsed.json"
```

### 3. Use with kepler.gl
Upload `parsed.json` to [kepler.gl](https://kepler.gl/demo) or use with local instance.

0 comments on commit 16eb46b

Please sign in to comment.