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 -c config.py
    

*On Windows, GDAL and Fiona dependencies are required. These easiest way to install these packages is to first download and install the Visual C++ Redistributable for Visual Studio 2015. Once available, compiled versions can be installed with Python's pip: - 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.13-cp37-cp37m-win_amd64.whl
```

Quick comands

Show help:

$ tripkit-cli --help

Logging verbosity:

$ tripkit-cli -q  # quiet (no output messages)
$ tripkit-cli -v  # verbose

Supply config:

$ tripkit-cli -c config.py

Write GIS data outputs

$ tripkit-cli

Config

Sample config:

##
## itinerum-tripkit configuration
##
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
ACTIVITY_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/'

##
## itinerum-tripkit-cli configuration
##
# GIS output formats: shp (shapefile), gpkg (geopackage), geojson
GIS_OUTPUT_FORMAT = 'shp'

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.11
Filename, size File type Python version Upload date Hashes
Filename, size itinerum_tripkit_cli-0.0.11-py3-none-any.whl (21.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size itinerum-tripkit-cli-0.0.11.tar.gz (6.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page