Skip to main content

A command-line interface for running the itinerum-tripkit library

Project description

itinerum-tripkit-cli

Python Version

The itinerum-tripkit-cli makes using the itinerum-tripkit library fast and simple:

  1. Create an ./input and ./output directory. Copy source .csv data to ./input.
  2. Edit a config.py file with data filepaths and trip processing parameters.
  3. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for itinerum-tripkit-cli, version 0.0.9
Filename, size File type Python version Upload date Hashes
Filename, size itinerum_tripkit_cli-0.0.9-py3-none-any.whl (20.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size itinerum-tripkit-cli-0.0.9.tar.gz (5.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page