A command-line interface for running the itinerum-tripkit library
Project description
itinerum-tripkit-cli
The itinerum-tripkit-cli
makes using the itinerum-tripkit
library fast and simple:
- Create an
./input
and./output
directory. Copy source .csv data to./input
. - Edit a
config.py
file with data filepaths and trip processing parameters. - Run the tripkit command-line tool*:
$ pip install itinerum-tripkit-cli $ tripkit-cli -v -c config.py
*On Windows, GDAL and Fiona dependencies are required. These easiest way to install these packages is to download pre-compiled versions: - GDAL: https://www.lfd.uci.edu/~gohlke/pythonlibs/#gdal - Fiona: https://www.lfd.uci.edu/~gohlke/pythonlibs/#fiona
```bash
$ pip install .\GDAL-3.0.2-cp37-cp37m-win_amd64.whl
$ pip install .\Fiona-1.8.11-cp37-cp37m-win_amd64.whl
```
Quick comands
Show help:
$ tripkit-cli --help
Increase logging verbosity:
$ tripkit-cli -v # verbose
$ tripkit-cli -vv # very verbose
Supply config:
$ tripkit-cli -c config.py
Config
Sample config:
SURVEY_NAME = 'itinerum_survey'
# path of raw data directory exported from Itinerum platform or Qstarz
INPUT_DATA_DIR = './input/csv-data-dir'
# types: "itinerum" or "qstarz"
INPUT_DATA_TYPE = 'itinerum'
# path of export data from itinerum-cli
OUTPUT_DATA_DIR = './output'
# path of subway station entrances .csv for trip detection
SUBWAY_STATIONS_FP = './input/subway_stations/stations.csv'
# trip detection parameters
TRIP_DETECTION_BREAK_INTERVAL_SECONDS = 300
TRIP_DETECTION_SUBWAY_BUFFER_METERS = 300
TRIP_DETECTION_COLD_START_DISTANCE_METERS = 750
TRIP_DETECTION_ACCURACY_CUTOFF_METERS = 50
# timezone of study area for calculating complete trip days
TIMEZONE = 'America/Montreal'
# semantic location radius for activity dwell tallies
SEMANTIC_LOCATION_PROXIMITY_METERS = 50
# OSRM map matcher API URLs
MAP_MATCHING_BIKING_API_URL = 'https://osrm.server.com/match/v1/biking/'
MAP_MATCHING_DRIVING_API_URL = 'https://osrm.server.com/match/v1/driving/'
MAP_MATCHING_WALKING_API_URL = 'https://osrm.server.com/match/v1/walking/'
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for itinerum-tripkit-cli-0.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c44a091215ead15b19004644041eb61eb0dbf7c66d046f7e62291a0217c17e6 |
|
MD5 | 350e0f4bf980b22b36c226c62bec2ac7 |
|
BLAKE2b-256 | 0f5fbe12f3ed3bc0afe1e51eaaa82e807488adec13d3251ee6fbea701e09c2c0 |
Close
Hashes for itinerum_tripkit_cli-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1671be232cce9ff505a41eaf8b0f818cf422b4312d70fccefcf2cd3a2e03dbf8 |
|
MD5 | 8d5d78e40e28539876443d609ecc8645 |
|
BLAKE2b-256 | 211ce84fe414932ddd4cc0dd0f3d70e0d2d5b85695c446b86541e197075b8c85 |