Skip to content

Soft Arm data visualization using Blender

Notifications You must be signed in to change notification settings

GazzolaLab/Blender-Soft-Rod

Repository files navigation

Blender Soft Arm

Documentation Status CI

The Blender Soft Arm (bsr) includes data visualization tools and analysis for soft-arm robotics data. The slender body is defined by a series of points and radius, and the data is visualized in Blender.

How to install

Easiest way to install the stable version of the package is to use pip:

pip install bsr

Examples

We provide minimal example scripts to demonstrate the usage of the package.

Development version

The development version includes unit-tests, documentation, examples, and other development tools. We primarily use poetry to manage the dependencies and the development environment. Necessary commands are provided in the Makefile.

git clone https://github.com/GazzolaLab/Blender-Soft-Rod.git
cd Blender-Soft-Rod
make install  # Assuming you have poetry installed.
make pre-commit-install

Below are additional commands that you can use to manage the development environment.

  • Documentation
cd docs
make clean
make html
open build/html/index.html
  • Unittests
make test
  • Code formatting
make formatting
  • Check type-hinting
make mypy