An open API service indexing awesome lists of open source software.

https://github.com/dvrpc/tmc-summarizer

Process raw TMC data into more functional formats.
https://github.com/dvrpc/tmc-summarizer

Last synced: 3 months ago
JSON representation

Process raw TMC data into more functional formats.

Awesome Lists containing this project

README

          

# tmc-summarizer

Process raw TMC data into more functional formats.

## Live Demo

Here: [http://167.172.146.34](http://167.172.146.34)

The codebase for the demo can be found at [`dvrpc\tmc-app`](https://github.com/dvrpc/tmc-app)

![image info](https://github.com/dvrpc/tmc-app/blob/master/static/assets/images/app_screenshot.png)

## Development environment setup:

Create and activate a virtual environment:

```bash
(base) $ conda create --name tmc_summarizer python=3.8
(base) $ conda activate tmc_summarizer
```

Install the third-party requirements:

```bash
(tmc_summarizer) $ pip install -r requirements.txt
```

Install this package in 'edit' mode

```bash
(tmc_summarizer) $ pip install -e .
```

## Execute via Python, CLI, or GUI:

In all cases, you'll need the proper python environment activated.

```bash
(base) $ conda activate tmc_summarizer
(tmc_summarizer) $
```

### Python

```python
>>> from tmc_summarizer import write_summary_file
>>> write_summary_file("/my/raw/data/folder", "/my/output/folder")
```

### Command Line Interface

Use the `tmc summarize` command to kick off the script. You need to specify a path where the data can be found.

```bash
(tmc_summarizer) $ tmc summarize my/data/
```

### Graphical User Interface

Use the `tmc gui` command to visually select your data folder.

```bash
(tmc_summarizer) $ tmc gui
```

## TODO

:white_check_mark: match functionality of prototype

:white_check_mark: add CLI hook

:white_check_mark: add GUI hook

:white_check_mark: write Flask-based web app

:black_square_button: write test suite

:black_square_button: test on Windows & Linux

## Questions:

`Light Vehicles` tab has `Peds in Crosswalk`, while the `Heavy Vehicles` tab has `Bikes in Crosswalk`. Is this intentional, or mislabeled data?