Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.34 KB

README.md

File metadata and controls

74 lines (48 loc) · 3.34 KB
Raw

Vision Zero Crash Data System

Vision Zero Viewer

The Vision Zero Crash Data System is a suite of tools which support the City of Austin's Vision Zero program, which seeks to reduce people hurt or killed by traffic crashes in Austin, TX.

The system has a primary focus on storing, editing, and analyzing traffic crash data, and comprises these core components:

  • Vision Zero Database (VZD): A postgresql database which stores crash and crash-related records
  • Vision Zero Editor (VZE): A web application which enables City staff to browse and edit crash data
  • Vision Zero Viewer (VZV): A public-facing dashboard which provides key metrics and insights about crash injuries and fatalities

This repository also holds integration scripts for consuming crash data from external sources, as well as publishing crash data to the City's Open Data Portal.

Table of contents

Quick start

You need access to the production VZ database in order to develop locally. There is currently no option to run the Vision Zero stack based on seed data.

The helper script, vision-zero, makes it easy to spin up your local Vision Zero stack. See the local development docs for more details.

  1. Create a new Python environment and install the packages in requirements.txt.

  2. Save a copy of the [environment template (env_template)](env_template) as .env`, and populate your database read replica credentials.

RR_USERNAME=""
RR_PASSWORD=""
RR_HOSTNAME=""
RR_DATABASE=""
  1. Start the DB
./vision-zero replicate-db

This command will:

  • Download a snapshot of the production database
  • Store the file in `./database/snapshots/visionzero-{date}-{with|without}-change-log.sql
  • Drop local atd_vz_data database
  • Create and repopulate the database from the snapshot

Note: the -f / --filename flag can be optionally used to point to a specific data dump .sql file to use to restore. The way the snapshots are dated means that one will only end up downloading one copy of the data per-day, both with and without change log data.

  1. Start the Vision Zero Editor
vision-zero vze-up

See here for in-depth documentation about the vision-zero helper.

Learn more

  • Vision Zero Database (VZD) - the database that powers the Vision Zero suite
  • Vision Zero Editor (VZE) - web application which enables City staff to browse and edit crash data
  • Vision Zero Viewer (VZV) - public dashboard which provides key metrics and insights about
  • api - our API that securely downloads a private file from S3
  • etl - integration scripts for bringing data in the Vision Zero Database
  • toolbox - collection of utilities and scripts designed for ad-hoc maintenance tasks

License

As a work of the City of Austin, this project is in the public domain within the United States.

Additionally, we waive copyright and related rights of the work worldwide through the CC0 1.0 Universal public domain dedication.