# yupi

Standing for *Yet Underused Path Instruments*, yupi is a set of tools designed 
for collecting, generating and processing trajectory data.  

## Installation

Current recommended installation method is via the pypi package:

```cmd
pip install yupi
```

## Getting Started

In the [official documentation](https://yupi.readthedocs.io/en/latest/) there 
are some resources to start using the library. A [Getting Started section](https://yupi.readthedocs.io/en/latest/getting_started/getting_started.html) provides an introduction for
newcomers and the [API reference section](https://yupi.readthedocs.io/en/latest/api_reference/api_reference.html) contains a detailed description of the API.


## Examples

Code examples (with additional multimedia resources) can be found in 
[this repository](https://github.com/yupidevs/yupi_examples). Additionally, in
the [Examples section](https://yupi.readthedocs.io/en/latest/examples/examples.html)
of the documentation, you can find the same examples with additional comments 
and expected execution results in order to inspect the examples without actually 
executing them.