Metadata-Version: 2.4
Name: drone_models
Version: 0.1.0b0
Summary: Models of quadrotor drones for estimation and control tasks.
Author: Marcel Rath, Martin Schuck
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Description-Content-Type: text/markdown
Requires-Dist: numpy>=2.0.0
Requires-Dist: scipy>=1.17.0rc1
Requires-Dist: casadi>=3.7.0
Requires-Dist: array-api-compat
Requires-Dist: array-api-extra

$$
\huge \displaystyle \dot{x} = f(x,u)
$$

---

Drone models @ LSY. Contains symbolic (CasADi) and numeric (array API, i.e., NumPy, JAX, ...) drone dynamics.

[![Python Version]][Python Version URL] [![Ruff Check]][Ruff Check URL] [![Tests]][Tests URL] [![Docs]][Docs URL]

[Python Version]: https://img.shields.io/badge/python-3.10+-blue.svg
[Python Version URL]: https://www.python.org

[Ruff Check]: https://github.com/utiasDSL/drone-models/actions/workflows/ruff.yml/badge.svg?style=flat-square
[Ruff Check URL]: https://github.com/utiasDSL/drone-models/actions/workflows/ruff.yml

[Tests]: https://github.com/utiasDSL/drone-models/actions/workflows/testing.yml/badge.svg
[Tests URL]: https://github.com/utiasDSL/drone-models/actions/workflows/testing.yml

[Docs]: https://github.com/utiasDSL/drone-models/actions/workflows/docs.yml/badge.svg
[Docs URL]: https://utiasdsl.github.io/drone-models/

## Overview
Collection of different drone dynamics models. Also includes meshes of each model.

## Installation

1. Clone repository `git clone git@github.com:utiasDSL/drone-models.git`
2. Enter repository `cd drone-models`
3. Install locally with `pip install -e .` or the pixi environment with `pixi install`, which can be activated with `pixi shell`


## Usage
`from drone_models import TODO`


## Testing
1. Install testing environment with `pixi install -e test`
1. Run tests with `pixi run -e test pytest`
