Metadata-Version: 2.4
Name: viva-safeland
Version: 0.2.2
Summary: A new freeware for safe validation of vision-based navigation in aerial vehicles
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: opencv-python>=4.12.0.88
Requires-Dist: pillow>=10.4.0
Requires-Dist: pygame>=2.6.1
Requires-Dist: zros>=0.1.10
Provides-Extra: docs
Requires-Dist: mkdocs>=1.6.1; extra == "docs"
Requires-Dist: mkdocs-material>=9.6.17; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.26.1; extra == "docs"
Dynamic: license-file

# ViVa-SAFELAND: A **Vi**sual **Va**lidation **Safe** **Land**ing Simulation Platform

[![PyPI version](https://badge.fury.io/py/viva_safeland.svg)](https://badge.fury.io/py/viva-safeland)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python versions](https://img.shields.io/pypi/pyversions/viva_safeland.svg)](https://pypi.org/project/viva-safeland)

<div align="center">
  <img
    src="https://github.com/user-attachments/assets/6dd8b893-0e0b-405e-a067-e8bfafdf30c5"
    width="1200"
    alt="viva_logo"
  />
</div>

**ViVa-SAFELAND** is an open-source simulation platform for testing and evaluating vision-based navigation strategies for unmanned aerial vehicles, with a special focus on autonomous landing in compliance with safety regulations.

<div align="center">
  <img 
    src="https://github.com/user-attachments/assets/958905f5-4615-4de5-9e56-77c02886dde2"
    alt="ViVa-SAFELAND tool"
    width="1200"
  />
  <figcaption>ViVa-SAFELAND: A Visual Validation Safe Landing Tool</figcaption>
</div>

This documentation contains the official implementation for the paper *"ViVa-SAFELAND: An Open-Source Simulation Platform for Safe Validation of Vision-based Navigation in Aerial Vehicles"*. It provides a safe, simple, and fair comparison baseline to evaluate and compare different visual navigation solutions under the same conditions.

<div align="center">
  <img 
    src="https://github.com/user-attachments/assets/24d245d4-1568-4f1b-be81-f74ed0d9c574"
    alt="ViVa-SAFELAND Operation" 
    width="1200"
  />
  <figcaption>Example of ViVa-SAFELAND operation</figcaption>
</div>

## Key Features

-   **Real-World Scenarios:** Utilize a collection of high-definition aerial videos from unstructured urban environments, including dynamic obstacles like cars and people.
-   **Emulated Aerial Vehicle (EAV):** Navigate within video scenarios using a virtual moving camera that responds to high-level commands.
-   **Standardized Evaluation:** Provides a safe and fair baseline for comparing different visual navigation solutions under identical, repeatable conditions.
-   **Development & Data Generation:** Facilitates the rapid development of autonomous landing strategies and the creation of custom image datasets for training machine learning models.
-   **Safety-Focused:** Enables rigorous testing and debugging of navigation logic in a simulated environment, eliminating risks to hardware and ensuring compliance with safety regulations.

## Documentation
For detailed usage instructions, examples, and API documentation, please refer to the [ViVa-SAFELAND Documentation](https://viva-safeland.github.io/viva_safeland/).

## Citation

If you use ViVa-SAFELAND in your research, please cite us.
