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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45a7ef0e70030039a6defb0e77989af1446d82f339b57afb90d51507d2c791d8 |
|
MD5 | aa046212365373725ace9e0f63ac8149 |
|
BLAKE2b-256 | af6e457478ea9fd8ce79b873659d721017b9af97a5ba947cfbf7719c2fa24b6f |
Close
Hashes for itinerum_tripkit_cli-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 293a9b01fa8ecce6f83d666202ce636bf08a128631e579de3271b85c6c5c000c |
|
MD5 | 31a0b79da36e8480da090c6f2ccd09c5 |
|
BLAKE2b-256 | 813521dffd8f13d367b36d9e057721205174782cbb754236d1ffdef21e040a9e |