Skip to content

VolpeUSDOT/wzdx-dashboard

Repository files navigation

Work Zone Data Exchange (WZDx) Dashboard

According to the specification, "the Work Zone Data Exchange (WZDx) Specification aims to make harmonized work zone data provided by infrastructure owners and operators (IOOs) available for third party use, making travel on public roads safer and more efficient through ubiquitous access to data on work zone activity." More information on this project can be found on the project's homepage.

At the time of writing, 25 different organizations provide data feeds that align with various versions of the specification, which can be viewed publicly on the U.S. DOT's public data portal. These feeds are archived regularly at the ITS Work Zone Sandbox, but there is currently no mechanism in place for Volpe team members to regularly ensure data validity, accuracy, freshness, or alignment with the specification.

This project aims to address this by creating an internal dashboard that will regularly query the public data hub for all available feeds and their metadata, validate individual feeds, and alert Volpe WZDx team members whenever an error or warning is found.

Getting Started

  1. Ensure the following dependencies are installed:
    • Python 3, at least 3.11
    • NodeJS, at least NodeJS 20
    • Spatial database software (either PostGIS or SpatiaLite) and relevant software (eg. GEOS, PROJ, GDAL, etc.)
  2. Install packages
    • pip install -r requirements.txt (and requirements-dev.txt for development)
    • npm install
  3. Create local_settings.py in ./project/src
    • This file should hold any relevant overrides for local development/production. This can include enabling DEBUG, adding env variables, adding a local SECRET_KEY, etc.
    • If you'd like a template, email please contact diego.temkin@dot.gov
  4. Create database and run server
    • Django commands can be run in your terminal using the ./project/manage.py file
    • Run python3 manage.py migrate to create the database of your choice and python3 manage.py runserver to run a local development server
    • Debug issues with your local installation consult Django documentation as needed

Suport

For support, please contact diego.temkin@dot.gov or avdx@dot.gov.

License

The WZDx Dashboard project is in the worldwide public domain (i.e., in the public domain within the United States - copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication). All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with the waiver of copyright interest. see License for more details.

About

Dashboard for monitoring WZDx feeds and alerting team members

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •