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:
Itinerum
$ pip install itinerum-tripkit-cli $ tripkit-cli -v -c config.py
QStarz
$ pip install itinerum-tripkit-cli $ tripkit-cli -v -c config.py
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c15aa2a3cc66934d81db96649b4d0cb64f1f4a0780e1e8624081bc655a26ca2f |
|
MD5 | d8720905e4c88ae7bbee2c6e79eccdeb |
|
BLAKE2b-256 | d1ea347a506c04c458333a764970c3c742ed788f4202f2a5d45c491887f38f6b |
Close
Hashes for itinerum_tripkit_cli-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 104ddff5ae6bcd88d64dac27adcc33ff6a2da362cfb210e1c6aa876f02f98296 |
|
MD5 | 34379be303c0dd6483b3113ff995917f |
|
BLAKE2b-256 | 8dca69c3b4c2b04eafa1c0e47208283302eff2cd1260f5bdfd840e9e6029a4d0 |