Metadata-Version: 2.4
Name: olfactory-navigation
Version: 1.0.5
Summary: A package to simulate the process of olfactory navigation in various environment using pre-built agents or user-made agents.
Author-email: Arnaud Ruymaekers <contact.aruymaekers@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Università degli Studi di Genova
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://pimlb.github.io/olfactory-navigation
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Olfactory Navigation Framework

![PyPI](https://img.shields.io/pypi/v/olfactory-navigation)
![Build](https://github.com/PimLb/olfactory-navigation/actions/workflows/pypi-publish.yml/badge.svg)
![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)

![Olfactory cues in turbulent air](https://raw.githubusercontent.com/PimLb/olfactory-navigation/main/docs/img/Odor_Plume.jpg)

This site contains the repository for the `olfactory-navigation` framework.

This project consists in a framework that allows one to define an olfactory environment and agents to navigate this environment in order to try and find the source of an odor using exclusively its sense of smell.

We can imagine for instance a dog attempting to find a treat in a field where the wind carries the odor towards him.

The framework aims to allow a user to create agents using different techniques and evaluate its performance (computational and technical) during simulations on olfactory environments.

## Documentation

https://pimlb.github.io/olfactory-navigation/
