Metadata-Version: 2.1
Name: airo-models
Version: 0.0.1
Summary: Curated URDFs and 3D models of the robots and gripper used at airo.
Author-email: Andreas Verleysen <andreas.verleysen@ugent.be>, Victor-Louis De Gusseme <victorlouisdg@gmail.com>
Project-URL: Homepage, https://github.com/airo-ugent/airo-models
Project-URL: Issues, https://github.com/airo-ugent/airo-models/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

# airo-models
Curated URDFs and 3D models of the robots and gripper used at airo.

## Installation
```
pip install git+https://github.com/airo-ugent/airo-models@main
```

## Usage
Get the path to a URDF file by a name:
```python
from airo_models.utils import get_urdf_path

ur5e_path = get_urdf_path("ur5e")
```

To check which models are available:
```python
from airo_models.utils import AIRO_MODEL_NAMES

print(AIRO_MODEL_NAMES)

>>> ['ur3e', 'ur5e', 'robotiq_2f_85']
```

### Local installation

- clone this repo
- create the conda environment `conda env create -f environment.yaml`
- initialize the pre-commit hooks `pre-commit install`

## Releasing
Releasing to PyPi is done automatically by github actions when a new tag is pushed to the main branch.
1. Update the version in `pyproject.toml`.
2. ```git tag -a v0.1.0 -m "airo-models v0.1.0"```
3. ```git push origin v0.1.0```

This was set up following [this guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/) first and then [this guide](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/).
