Metadata-Version: 2.4
Name: verus
Version: 1.0.1
Summary: A scientific tool to extract and analyze urban spatiotemporal vulnerability.
Author-email: "João Carlos N. Bittencourt" <joaocarlos@ufrb.edu.br>
Maintainer: LES2 FEUP faculty memebers
License: MIT License
Project-URL: Homepage, https://github.com/les2feup/verus
Project-URL: Bug Tracker, https://github.com/les2feup/verus/issues
Project-URL: Documentation, https://les2feup.github.io/verus/
Project-URL: Code Repository, https://github.com/les2feup/verus
Keywords: GIS,Vulnerability,Assessment,OpenStreetMap,Clustering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.20.0
Requires-Dist: pandas>=1.3.0
Requires-Dist: geopandas>=0.10.0
Requires-Dist: shapely>=1.8.0
Requires-Dist: pyproj>=3.0.0
Requires-Dist: osmnx>=1.1.0
Requires-Dist: rtree>=1.0.0
Requires-Dist: folium>=0.12.0
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: plotly>=5.3.0
Requires-Dist: scikit-learn>=1.0.0
Requires-Dist: colorama>=0.4.4
Requires-Dist: tqdm>=4.62.0
Requires-Dist: requests>=2.26.0
Requires-Dist: haversine>=2.3.0
Requires-Dist: branca>=0.4.0
Provides-Extra: dev
Requires-Dist: pytest>=6.2.5; extra == "dev"
Requires-Dist: black>=22.1.0; extra == "dev"
Requires-Dist: isort>=5.10.1; extra == "dev"
Requires-Dist: flake8>=4.0.1; extra == "dev"
Requires-Dist: mypy>=0.910; extra == "dev"
Requires-Dist: coverage>=6.2; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=4.3.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
Requires-Dist: nbsphinx>=0.8.8; extra == "docs"
Provides-Extra: viz
Requires-Dist: seaborn>=0.11.2; extra == "viz"
Requires-Dist: plotly>=5.3.0; extra == "viz"
Dynamic: license-file

![LES2 Logo](./src/figures/les2banner.png)

# VERUS

_Vulnerability Evaluation for Resilient Urban Systems_

![Python](https://img.shields.io/badge/Python-3.8%2B-blue?style=for-the-badge&logo=python)
![Jupyter Notebook](https://img.shields.io/badge/Jupyter-Notebook-orange?style=for-the-badge&logo=jupyter)
![OSMnx](https://img.shields.io/badge/OSMnx-1.1.1-blue?style=for-the-badge&logo=openstreetmap)
![Folium](https://img.shields.io/badge/Folium-0.12.1-green?style=for-the-badge&logo=folium)
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen?style=for-the-badge)](https://joaocarlos.github.io/verus/)
![Version](https://img.shields.io/badge/version-0.1.0-blue?style=for-the-badge&logo=github)

## Description

VERUS (Vulnerability Evaluation for Resilient Urban Systems) is a Python library for extracting points of interest from OpenStreetMap, clustering them based on spatial proximity and time-based vulnerability indices, and analyzing urban vulnerability patterns.

## Documentation

Comprehensive documentation is available at [https://joaocarlos.github.io/verus/](https://joaocarlos.github.io/verus/)

## Publications

-   Bittencourt, J. C. N., Costa, D. G., Portugal, P., & Vasques, F. (2024). A data-driven clustering approach for assessing spatiotemporal vulnerability to urban emergencies. Sustainable Cities and Society, 108, 105477. <https://doi.org/10.1016/j.scs.2024.105477>

## Installation

```bash
pip install verus
```

## Reproducing Results

To reproduce the results from the paper, run the following Jupyter Notebooks:

-   [01-Porto.ipynb](./notebooks/01-Porto.ipynb)
-   [02-Lisbon.ipynb](./notebooks/02-Lisbon.ipynb)
-   [03-Paris.ipynb](./notebooks/03-Paris.ipynb)

## Usage

## Contributions

## Licence

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
