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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 810c3ea0a3e73377499743d31c9c81a201be869c8cc4817c612971fe2fee19eb |
|
MD5 | a5c6edee841a10f4af8d2ce1569bc676 |
|
BLAKE2b-256 | be7bb97e4daadab00f57bb9618ebfe4c6bc4f40363221fb2de2ec3be4fc28b09 |
Close
Hashes for itinerum_tripkit_cli-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4468966e3a91131e90090a29fdd054e19ff7bfde717fa359fbcd3dd72e80c9b7 |
|
MD5 | 571d39743cf7b5a7c51da61af780440d |
|
BLAKE2b-256 | f81762b1f70b7fab5fcc0e679ef9d41654fe2082932a228eddac7cd29458fbe9 |