# A `rerun-sdk` plugin and tools for 3D animation
[![Python Version](https://img.shields.io/pypi/pyversions/rerun-animation.svg)](https://pypi.org/project/rerun-animation)
[![PyPI](https://img.shields.io/pypi/v/rerun-animation.svg)](https://pypi.org/project/rerun-animation)
![PyPI - Status](https://img.shields.io/pypi/status/rerun-animation)
[![PyPI - License](https://img.shields.io/pypi/l/rerun-animation)](https://github.com/moverseai/rerun-animation/blob/main/LICENSE)
[![Static Badge](https://img.shields.io/badge/docs-link-8A2BE2?style=flat&link=https%3A%2F%2Fmoverseai.github.io%2Frerun-animation%2F)](https://moverseai.github.io/rerun-animation/)
[![Discord](https://dcbadge.limes.pink/api/server/bQc7B6qSPd?style=flat)](https://discord.gg/bQc7B6qSPd)
<!-- [![Discord2](https://img.shields.io/badge/server-7289DA?logo=discord&logoColor=white&label=discord)](https://discord.gg/bQc7B6qSPd) -->
<!-- <a href="https://discord.gg/bQc7B6qSPd"><img src="https://img.shields.io/discord/1069970354937806970?logo=discord&logoColor=violet&label=discord" alt="Active Discord Server Users"/></a> -->
[![GitHub Release Date](https://img.shields.io/github/release-date/moverseai/rerun-animation)](https://github.com/moverseai/rerun-animation/releases)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/rerun-animation?style=plastic&logo=python&logoColor=magenta&color=magenta&link=https%3A%2F%2Fpypi.org%2Fproject%2Frerun-animation%2F)](https://pypi.org/project/rerun-animation/)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ace5cb2d5105429da91010170445d4c6)](https://app.codacy.com/gh/moverseai/rerun-animation/dashboard)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
<!-- [![CodeFactor](https://www.codefactor.io/repository/github/moverseai/rerun-animation/badge)](https://www.codefactor.io/repository/github/moverseai/rerun-animation) -->
<!-- [![Downloads](https://static.pepy.tech/badge/rerun-animation)](https://pepy.tech/project/rerun-animation) -->
[![Black Format](https://github.com/moverseai/rerun-animation/actions/workflows/black.yaml/badge.svg)](https://github.com/moverseai/rerun-animation/actions/workflows/black.yaml)
[![GitHub Pages](https://github.com/moverseai/rerun-animation/actions/workflows/gh-pages.yaml/badge.svg)](https://github.com/moverseai/rerun-animation/actions/workflows/gh-pages.yaml)
___
<!-- [![Downloads](https://static.pepy.tech/badge/rerun-animation/month)](https://pepy.tech/project/rerun-animation) -->
> ➿`rerun-animation` turns the [rerun-sdk](https://www.rerun.io) viewer to a `3D animation` viewer.
![intro](https://github.com/moverseai/rerun-animation/raw/main/docs/assets/gif/rerun_animation_amass_multi.gif)
## 📦 Features
With the `rerun-animation` ➿ package users can:
- `install` a [rerun-loader-plugin](https://rerun.io/blog/data-loaders) to drag-n-drop `3D animation` files in the [`rerun-viewer`](https://rerun.io/docs/reference/viewer/overview).
- `execute` commands to log `3D animation` data to a [`rerun`](https://www.rerun.io) instance.
`rerun-animation` supports the following types of `3D animation` data:
1. Biovision Hierarchy files (`*.bvh`)
2. Parametric Human Body parameter files (`*.npz`) from <a style="display: inline;" href="https://meshcapade.com/"><img src="https://meshcapade.com/images/meshcapade_logo_white.svg" width=120 style="display: inline;vertical-align:middle;horizontal-align:top;margin:0px 0px 5px 0px"></a>
<!-- ☘️ 🌟 📣 💼 💾 👩💻 🎯 🥇 👑 💯 🏆 🎉 ⚡ 🔥 🐍 📌 📈 📝 🧩 📄 📖 🚀 📚 💡 🤝 🤍 💚 🧱 ⚙️ 🔗 ⭐ 📦 📰 🛠 🎁 ⏳ 🎓 👋 ✨ 🧮 ✅ 👀 -->
## 👩💻 Documentation
Up-to-date [documentation](https://moverseai.github.io/rerun-animation/docs/) is available online.
## 💾 Installation
```sh
pip install rerun-animation
```
> [!WARNING]
> `rerun-animation` has only been tested on Windows up to now, if you use another OS please submit your [feedback](#-get-involved) in case of errors.
### ⚒ Post-installation deployment
### `*.bvh` only
```sh
rerun-animation-deploy
```
### with `smpl(-h)` support
```sh
rerun-animation-deploy --body_data_root `PATH/TO/BODY/MODELS`
```
## ⏩ Quickstart
1. (_optional_) Select a visualization configuration
```sh
rerun-animation-config select CONFIG-NAME
```
2. Open the viewer
```sh
rerun-animation
```
3. Drag-n-drop a `*.bvh` or `*.npz` file
![quick-start](https://github.com/moverseai/rerun-animation/raw/main/docs/assets/gif/rerun_animation_quick_start.gif)
## 🤝 Get Involved
Feedback and contributions are welcome via GitHub ([issue](https://github.com/moverseai/rerun-animation/issues/new)/[PR](https://github.com/moverseai/rerun-animation/compare)) and [Discord](https://discord.gg/bQc7B6qSPd).
Raw data
{
"_id": null,
"home_page": "https://moverseai.github.io/rerun-animation/",
"name": "rerun-animation",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.10",
"maintainer_email": null,
"keywords": "rerun-sdk, animation, plugin, visualization, 3d-animation, 3d-visualization, bvh, smpl, smplh, biovision-hierarchy",
"author": "Moverse P.C.",
"author_email": "info@moverse.ai",
"download_url": "https://files.pythonhosted.org/packages/ab/55/2cc6fe957cd70712d48b7bdb2fb9454bda132583fefd8be86aa6d04e3754/rerun_animation-0.1.4.tar.gz",
"platform": null,
"description": "# A `rerun-sdk` plugin and tools for 3D animation\n\n[![Python Version](https://img.shields.io/pypi/pyversions/rerun-animation.svg)](https://pypi.org/project/rerun-animation)\n[![PyPI](https://img.shields.io/pypi/v/rerun-animation.svg)](https://pypi.org/project/rerun-animation)\n![PyPI - Status](https://img.shields.io/pypi/status/rerun-animation)\n[![PyPI - License](https://img.shields.io/pypi/l/rerun-animation)](https://github.com/moverseai/rerun-animation/blob/main/LICENSE)\n[![Static Badge](https://img.shields.io/badge/docs-link-8A2BE2?style=flat&link=https%3A%2F%2Fmoverseai.github.io%2Frerun-animation%2F)](https://moverseai.github.io/rerun-animation/)\n[![Discord](https://dcbadge.limes.pink/api/server/bQc7B6qSPd?style=flat)](https://discord.gg/bQc7B6qSPd)\n<!-- [![Discord2](https://img.shields.io/badge/server-7289DA?logo=discord&logoColor=white&label=discord)](https://discord.gg/bQc7B6qSPd) -->\n<!-- <a href=\"https://discord.gg/bQc7B6qSPd\"><img src=\"https://img.shields.io/discord/1069970354937806970?logo=discord&logoColor=violet&label=discord\" alt=\"Active Discord Server Users\"/></a> -->\n\n[![GitHub Release Date](https://img.shields.io/github/release-date/moverseai/rerun-animation)](https://github.com/moverseai/rerun-animation/releases)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/rerun-animation?style=plastic&logo=python&logoColor=magenta&color=magenta&link=https%3A%2F%2Fpypi.org%2Fproject%2Frerun-animation%2F)](https://pypi.org/project/rerun-animation/)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ace5cb2d5105429da91010170445d4c6)](https://app.codacy.com/gh/moverseai/rerun-animation/dashboard)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n<!-- [![CodeFactor](https://www.codefactor.io/repository/github/moverseai/rerun-animation/badge)](https://www.codefactor.io/repository/github/moverseai/rerun-animation) -->\n<!-- [![Downloads](https://static.pepy.tech/badge/rerun-animation)](https://pepy.tech/project/rerun-animation) -->\n\n[![Black Format](https://github.com/moverseai/rerun-animation/actions/workflows/black.yaml/badge.svg)](https://github.com/moverseai/rerun-animation/actions/workflows/black.yaml)\n[![GitHub Pages](https://github.com/moverseai/rerun-animation/actions/workflows/gh-pages.yaml/badge.svg)](https://github.com/moverseai/rerun-animation/actions/workflows/gh-pages.yaml)\n___\n\n<!-- [![Downloads](https://static.pepy.tech/badge/rerun-animation/month)](https://pepy.tech/project/rerun-animation) -->\n\n\n> \u27bf`rerun-animation` turns the [rerun-sdk](https://www.rerun.io) viewer to a `3D animation` viewer.\n\n![intro](https://github.com/moverseai/rerun-animation/raw/main/docs/assets/gif/rerun_animation_amass_multi.gif)\n\n## \ud83d\udce6 Features\n\nWith the `rerun-animation` \u27bf package users can:\n- `install` a [rerun-loader-plugin](https://rerun.io/blog/data-loaders) to drag-n-drop `3D animation` files in the [`rerun-viewer`](https://rerun.io/docs/reference/viewer/overview).\n- `execute` commands to log `3D animation` data to a [`rerun`](https://www.rerun.io) instance.\n\n`rerun-animation` supports the following types of `3D animation` data:\n1. Biovision Hierarchy files (`*.bvh`)\n2. Parametric Human Body parameter files (`*.npz`) from <a style=\"display: inline;\" href=\"https://meshcapade.com/\"><img src=\"https://meshcapade.com/images/meshcapade_logo_white.svg\" width=120 style=\"display: inline;vertical-align:middle;horizontal-align:top;margin:0px 0px 5px 0px\"></a> \n\n<!-- \u2618\ufe0f \ud83c\udf1f \ud83d\udce3 \ud83d\udcbc \ud83d\udcbe \ud83d\udc69\u200d\ud83d\udcbb \ud83c\udfaf \ud83e\udd47 \ud83d\udc51 \ud83d\udcaf \ud83c\udfc6 \ud83c\udf89 \u26a1 \ud83d\udd25 \ud83d\udc0d \ud83d\udccc \ud83d\udcc8 \ud83d\udcdd \ud83e\udde9 \ud83d\udcc4 \ud83d\udcd6 \ud83d\ude80 \ud83d\udcda \ud83d\udca1 \ud83e\udd1d \ud83e\udd0d \ud83d\udc9a \ud83e\uddf1 \u2699\ufe0f \ud83d\udd17 \u2b50 \ud83d\udce6 \ud83d\udcf0 \ud83d\udee0 \ud83c\udf81 \u23f3 \ud83c\udf93 \ud83d\udc4b \u2728 \ud83e\uddee \u2705 \ud83d\udc40 -->\n\n## \ud83d\udc69\u200d\ud83d\udcbb Documentation\n\nUp-to-date [documentation](https://moverseai.github.io/rerun-animation/docs/) is available online. \n\n\n## \ud83d\udcbe Installation\n\n```sh\npip install rerun-animation\n```\n\n> [!WARNING] \n> `rerun-animation` has only been tested on Windows up to now, if you use another OS please submit your [feedback](#-get-involved) in case of errors.\n\n### \u2692 Post-installation deployment\n\n### `*.bvh` only\n```sh\nrerun-animation-deploy\n```\n\n### with `smpl(-h)` support\n\n```sh\nrerun-animation-deploy --body_data_root `PATH/TO/BODY/MODELS`\n```\n\n## \u23e9 Quickstart\n\n1. (_optional_) Select a visualization configuration\n```sh\nrerun-animation-config select CONFIG-NAME\n```\n2. Open the viewer\n```sh\nrerun-animation\n```\n3. Drag-n-drop a `*.bvh` or `*.npz` file\n\n![quick-start](https://github.com/moverseai/rerun-animation/raw/main/docs/assets/gif/rerun_animation_quick_start.gif)\n\n\n## \ud83e\udd1d Get Involved\n\nFeedback and contributions are welcome via GitHub ([issue](https://github.com/moverseai/rerun-animation/issues/new)/[PR](https://github.com/moverseai/rerun-animation/compare)) and [Discord](https://discord.gg/bQc7B6qSPd).\n",
"bugtrack_url": null,
"license": null,
"summary": "A rerun-sdk plugin and tools for 3D animation.",
"version": "0.1.4",
"project_urls": {
"Documentation": "https://moverseai.github.io/rerun-animation/",
"Homepage": "https://moverseai.github.io/rerun-animation/",
"Source": "https://github.com/moverseai/rerun-animation/"
},
"split_keywords": [
"rerun-sdk",
" animation",
" plugin",
" visualization",
" 3d-animation",
" 3d-visualization",
" bvh",
" smpl",
" smplh",
" biovision-hierarchy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aaa7af1421a9ddb97ba79f5a8bb8f4ca2dc60631e26e4bcf515d35024fec955d",
"md5": "8e804f8cb47ffc8b12dc7c7e650d7c68",
"sha256": "55416c5ce6783971d7a18c36e73f59959e1c8310320178a41d1f899787e518dc"
},
"downloads": -1,
"filename": "rerun_animation-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e804f8cb47ffc8b12dc7c7e650d7c68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.10",
"size": 25952,
"upload_time": "2024-11-06T21:17:37",
"upload_time_iso_8601": "2024-11-06T21:17:37.655569Z",
"url": "https://files.pythonhosted.org/packages/aa/a7/af1421a9ddb97ba79f5a8bb8f4ca2dc60631e26e4bcf515d35024fec955d/rerun_animation-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab552cc6fe957cd70712d48b7bdb2fb9454bda132583fefd8be86aa6d04e3754",
"md5": "35ab1f518fc78a80bdc559879b763e03",
"sha256": "0780a81160bc1d3cb9236d97a5083a11cbadbb067a14afad1047a83dc5102628"
},
"downloads": -1,
"filename": "rerun_animation-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "35ab1f518fc78a80bdc559879b763e03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.10",
"size": 23647,
"upload_time": "2024-11-06T21:17:38",
"upload_time_iso_8601": "2024-11-06T21:17:38.830030Z",
"url": "https://files.pythonhosted.org/packages/ab/55/2cc6fe957cd70712d48b7bdb2fb9454bda132583fefd8be86aa6d04e3754/rerun_animation-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 21:17:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "moverseai",
"github_project": "rerun-animation",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "rerun-animation"
}