Construido con:

Acerca del Proyecto 🎯

Buscamos determinar si existe una relacion entre la presencia y/o permanencia de baches en las calles versus las caracteristicas socioeconomicas, para distintas zonas del municipio de Hermosillo, Sonora.

Consideramos que los resultados serian de especial interes para todo ciudadano que reside en el municipio de Hermosillo, Sonora, sin embargo tambien podrian servir de referencia a las autoridades locales e inclusive a habitantes de otras localidades de Mexico.

Estructura del Proyecto 📁

├── modules  <- Codigo fuente del proyecto
│   │
│   ├── __init__.py    <- Convierte el contenido de la carpeta modules en un modulo de Python
│   │
│   ├── dataset.py     <- Script para descarga de datos
│   │
│   ├── tidying.py     <- Script para procesar datos crudos y darles un formato tidy
│   │
│   ├── tools.py       <- Archivo con funciones desarrolladas para el proyecto
│   │
│   ├── config.py      <- Archivo para depositar configuraciones y variables
│   │
│   └── templates      <- El directorio con los datos en formato tidy
│       │
│       ├── data_download_log_template  <- Plantilla para bitacora de descarga de datos
│       │
│       └── data_tidying_log_template   <- Plantilla para bitacora de procesamiento de datos a formato tidy
│
├── data
│   ├── raw            <- El directorio con datos crudos - originales e inmutables
│   │
│   └── processed      <- El directorio con los datos en formato tidy
│
├── README.md          <- El README principal para desarrolladores que usaran el proyecto
│
├── Makefile           <- Makefile con comandos que facilitan el uso del proyecto
│
├── references         <- Diccionarios de datos, manuales, y otro material explicativo
│   │
│   ├── raw     <- El directorio con los diccionarios de datos crudos
│   │   │
│   │   ├── baches_raw_diccionario.md  <- Diccionario Datos Baches crudos
│   │   │
│   │   └── socioeconomico_2020_raw_diccionario.md   <- Diccionario Datos SE crudos
│   │
│   └── processed     <- El directorio con los diccionarios de datos en formato tidy
│       │
│       ├── baches_processed_diccionario.md  <- Diccionario Datos Baches/AGEB Tidy
│       │
│       └── socioeconomico_2020_processed_diccionario.md   <- Diccionario Datos SE Tidy
│
├── reports            <- Reportes de analisis (HTML, PDF, LaTeX, etc.)
│   │
│   ├── baches_report.html          <- Reporte EDA sobre datos de baches HMO
│   │
│   ├── hmo_ec_2020_report.html     <- Reporte EDA sobre datos socioeconomicos de HMO
│   │
│   └── figures        <- Generated graphics and figures to be used in reporting
│
├── requirements.txt   <- Archivo que contiene los requerimientos (dependencias) para crear
│                         el entorno virtual. Para este proyecto se genero con
│                         "pip3 freeze > requirements.txt"
│
├── notebooks          <- Jupyter Notebooks utilizados unicamente, de momento, para pruebas
│
├── LICENSE            <- Licencia Open-Source del MIT adaptada para el proyecto
│
├── docs               <- Proyecto default de mkdocs
│
├── models             <- Directorio destinado a modelos - Temporalmente sin uso
│
├── pyproject.toml     <- Archivo de configuracion de proyecto con metadata del
│                         paquete/modulo baches_hermosillo y configuracion para
│                         otras herramientas e.g. black (formato)
│
└── setup.cfg          <- Archivo de configuracion para flake8

Guia de Uso 📓

Clonando el Repositorio 🔻

1. Desde una terminal, navegar hasta el directorio donde se desea clonar el repositorio

   cd "<ruta_del_directorio>"

2. Clonar el repositorio

   git clone https://github.com/BSM-Analytics/proyecto-baches-hmo.git

Con Python 🐍

Creando el Entorno Virtual

1. Desde una terminal, navegar hasta el directorio donde se clono el repositorio

   cd "<ruta_del_directorio_con_respositorio_clonado>"

2. Crear un entorno virtual con las herramientas nativas de Python (venv -> virtual env) NOTA: Tambien puedes crearlo con conda u otras herramientas de tu preferencia

   python3 -m venv <nombre_del_entorno>

3. Activar el entorno virtual

   source activate <nombre_del_entorno>

4. Instalar las dependencias del proyecto. Estas se encuentran en el documento requirements.txt

   pip3 install requirements.txt

5. Opcional: Puedes verificar que se hayan instalado los paquetes utilizando la funcion list de pip

   pip3 list

Descargando los Datos

1. Desde una terminal, estando ubicado en el directorio raiz del proyecto, navegar hacia el directorio modules

   cd modules

2. Ejecutar el script de Python denominado dataset.py. Este descargara todos los datos a la carpeta data/raw

   python3 dataset.py

3. Opcional: Verificar que se hayan descargado los datos a la carpeta data/raw

   ls -d ./data/raw

Procesando los Datos a Formato Tidy

1. Desde una terminal, estando ubicado en el directorio raiz del proyecto, navegar hacia el directorio modules

   cd modules

2. Ejecutar el script de Python denominado tidy.py. Esto procesara todos los datos ubicados en data/raw y generara los conjuntos de datos tidy en la carpeta data/processed

   python3 tidy.py

3. Opcional: Verificar que se hayan descargado los datos a la carpeta data/processed

   ls -d ./data/processed

Con Make ➡️

1. Se puede ejecutar el pipeline completo con el comando:

   make execute_full_pipeline

2. Para ejecutar el pipeline por cada una de sus etapas, se puede utilizar los siguientes comandos:

   make create_venv

   make activate_venv

   make install_venv_requirements

   make download_data

   make tidy_data

EDAs 📊

1. Reporte Datos Baches
2. Reporte Datos Socioeconomicos

Fuentes ℹ️

1. API del Sitio Web del Bachometro del Ayuntamiento de Hermosillo
2. AGEBS INEGI Hermosillo (2021)
3. Indicadores Socioeconomicos INEGI Hermosillo (2020)

Licenciamiento 📜

Distribuido bajo la licencia del MIT. Para mas informacion consulte el documento LICENSE.

Contacto 📬

Desarrolladores: ⌨️

• Jesus Solis | Email: jesolis_14@hotmail.com | LinkedIn JMSD
• Sebastian Browarski | Email: sebas.browar@gmail.com | LinkedIn SBR
• Fernando Martinez | Email: lfmartinezmendoza@gmail.com | LinkedIn LFMM