Skip to content

Commit

Permalink
Improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
JosePabloGFnl committed Aug 26, 2024
1 parent 11b9a7d commit a752964
Showing 1 changed file with 52 additions and 6 deletions.
58 changes: 52 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# Tool for Analysis and Visualization of Violent Crimes in the Metropolitan Area of Monterrey.
# Tool for Analysis and Visualization of Violent Crimes in the Metropolitan Area of Monterrey

## Table of Contents
- [Demo](#demo)
- [Features](#features)
- [Future Work](#future-work)
- [Installation](#installation)
- [Contributing](#contributing)
- [License](#license)

## Demo

-----
**DEMO on Streamlit** <br />
https://ernestosaleh-tigereye-1--inicio-j7lxd4.streamlit.app/Tipos_de_Violencia
-----

## Features

This demo offers:
- Visualization of the **total crimes**.
- Visualization of **crimes per capita**.

The user is able to select the
<span style="color:magenta">**type of crime** </span>
and
<span style="color:magenta">**time range** </span> they want to observe.
**type of crime** and **time range** they want to observe.

## Future Work

This project aims to include:
- Tools to correlate external factors.
Expand All @@ -21,6 +31,42 @@ This project aims to include:
- Interface to visualize relevant news.
- Development tools to scale this tool to more cities.

## Installation

1. Clone the repository:
```sh
git clone https://github.com/JosePabloGFnl/Monterrey-Violence.git
cd Monterrey-Violence
```

2. Create a virtual environment:
```sh
python -m venv venv
```

3. Activate the virtual environment:
- On Windows:
```sh
venv\Scripts\activate
```
- On macOS/Linux:
```sh
source venv/bin/activate
```

4. Install the required packages:
```sh
pip install -r requirements.txt
```

## Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

## License

This project is licensed under the MIT License. See the LICENSE file for details.

For more information and conceptual graphs, see **"pitch.pdf"**.

For more information on data processing and exploratory analysis, go to https://github.com/JosePabloGFnl/Monterrey-Violence

0 comments on commit a752964

Please sign in to comment.