From a752964ebf1970dd967559b66bad112f94a7d51b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Gonz=C3=A1lez?= Date: Mon, 26 Aug 2024 13:51:48 -0600 Subject: [PATCH] Improved README --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b9621e1..fe9aaf2 100644 --- a/README.md +++ b/README.md @@ -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**
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 -**type of crime** -and -**time range** 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. @@ -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 \ No newline at end of file