Skip to content

Commit

Permalink
bump to 0.0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
nmvrs committed Sep 1, 2024
1 parent 24267cc commit 805ab25
Show file tree
Hide file tree
Showing 10 changed files with 73 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -177,5 +177,5 @@ node_modules/
*.dll
*.exe
*.ini
!rerun-animation/configs/*.ini
!rerun_animation/configs/*.ini
bin/
70 changes: 68 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,68 @@
# rerun-animation
A rerun plugin and tools for 3D animation
# 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)
![Static Badge](https://img.shields.io/badge/docs-link-8A2BE2?style=flat&link=https%3A%2F%2Fmoverseai.github.io%2Frerun-animation%2F)

![GitHub Release Date](https://img.shields.io/github/release-date/moverseai/rerun-animation)
[![Downloads](https://static.pepy.tech/badge/rerun-animation)](https://pepy.tech/project/rerun-animation)
<!-- [![Downloads](https://static.pepy.tech/badge/rerun-animation/month)](https://pepy.tech/project/rerun-animation) -->


> `rerun-animation` turns the <a style="display: inline;" href="https://www.rerun.io"><img src="https://rerun.io/logo.svg/" width=72 style="display: inline;"></a> viewer to a `3D animation` viewer.
![intro](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
```

### 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](docs/assets/gif/rerun_animation_quick_start.gif)
## Get Involved
Feedback and contributions are welcome via GitHub (issues/PR) and Discord.
Binary file added docs/assets/gif/rerun_animation_amass_multi.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gif/rerun_animation_amass_smplh.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gif/rerun_animation_configs_bvh.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gif/rerun_animation_intro_small.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gif/rerun_animation_quick_start.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ For more information, see [Why this project?]()
-->

{{< alert >}}
**Warning!** The plugin is still in alpha but its functionality is not expected to change as it depends on `rerun-sdk` plugin system changes.
**Warning!** The plugin is now in beta but its functionality is not expected to change as it depends on `rerun-sdk` plugin system changes.
Compatibility with specific `rerun-sdk` versions might be necessary because of this.
Apart from integrating with `rerun-sdk` via the loader plugin, the `rerun-animation` package offers an additional configuration layer and extra tools.
Once these have been stabilized and most bugs have been identified and solved, we will bump `rerun-animation` to a stable release.
Expand Down
2 changes: 1 addition & 1 deletion rerun_animation/configs/amass.ini
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ color = gray
pose_type = axisangle

[rerun]
up_axis = y
up_axis = z
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def get_requirements():
return requirements

PACKAGE_NAME = 'rerun-animation'
VERSION = '0.0.6'
VERSION = '0.0.7'
AUTHOR = 'Moverse P.C.'
EMAIL = 'info@moverse.ai'
LICENSE = 'Apache 2.0'
Expand Down Expand Up @@ -80,7 +80,7 @@ def get_requirements():
],
},
classifiers=[
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Programming Language :: Python :: 3.10",
Expand Down

0 comments on commit 805ab25

Please sign in to comment.