Getting started with itinerum-tripkit-cli

The itinerum-tripkit-cli is designed to get started with using the itinerum-tripkit library easily and without needing to write any code. Nevertheless, as a Python command-line utility, some setup is required.

Requirements:

Python3 installed and globally accessible from the command-line. If Python3 is available on your system as python3, use that instead of python when following this guide.
On Windows:
- The Visual C++ Redistributable for Visual Studio 2015 (13.4MB)
- Compiled binaries for GDAL and Fiona dependencies (find these here). Be sure to download the library version compatible with your Python installation (e.g., GDAL‑3.0.3‑cp37‑cp37m‑win_amd64.whl for 64-bit Python 3.7)

Note on Windows PowerShell

If activating the virtual environment gives the error “Running scripts is disabled on this system”, PowerShell must be set to allow unsigned scripts. This can be fixed by running Set-ExecutionPolicy Unrestricted -Force and restarting the shell. For more information, see the Python Virtual Env documentation.

Installation:

Create a project workspace
Windows only: Add compiled binary dependencies to an easily accessible directory. In the video example, a vendor folder is created and used.

Install all project dependencies. Installations on MacOS and Linux can create the virtual environment and skip directly to the pip install itinerum-tripkit-cli command.

Commands:

 python -m venv tripkit-venv
 tripkit-venv/Scripts/Activate.ps1
 pip install vendor/GDAL‑3.0.3‑cp37‑cp37m‑win_amd64.whl
 pip install vendor/Fiona‑1.8.13‑cp37‑cp37m‑win_amd64.whl
 pip install itinerum-tripkit-cli

Create the directories for input and output data. Add source .csv coordinates and subway stations data (if declared in config). Add the tripkit configuration file (sample below).

Running:

Run the itinerum-tripkit-cli with the desired options (available from help menu)

Commands:
```
 tripkit.exe --help
 tripkit.exe -c config_file.py
```

Config sample: Configs named tripkit_config.py will be used automatically; configs with other filenames can be specified with the -c parameter).

#!/usr/bin/env python

# filename for the itinerum-cli database
SURVEY_NAME = 'itinerum'

# path of raw data directory exported from Itinerum platform or Qstarz
INPUT_DATA_DIR = './input/itinerum-csv'
# 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/mtl_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'

# location radius for activity dwell tallies
SEMANTIC_LOCATIONS = {
    'home': ['location_home_lat', 'location_home_lon'],
    'work': ['location_work_lat', 'location_work_lon'],
    'study': ['location_study_lat', 'location_study_lon']
}
ACTIVITY_LOCATION_PROXIMITY_METERS = 50

# OSRM map matcher API URLs
MAP_MATCHING_BIKING_API_URL = 'https://osrmserver.com/osrm/match/v1/biking/'
MAP_MATCHING_DRIVING_API_URL = 'https://osrmserver.com/osrm/match/v1/driving/'
MAP_MATCHING_WALKING_API_URL = 'https://osrmserver.com/osrm/match/v1/walking/'

itinerum-tripkit-cli

A command-line interface for the itinerum-tripkit library

Getting started with itinerum-tripkit-cli