| Name | bsr JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Blender integration tools for soft-rod system. |
| upload_time | 2024-06-22 21:53:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.10 |
| license | MIT |
| keywords |
data-analysis
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<h1> Blender Soft Arm </h1>
<img src="https://img.shields.io/badge/Python-3776AB?style=flat&logo=Python&logoColor=white"/>
<a href='https://blender-soft-rod.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/blender-soft-rod/badge/?version=latest' alt='Documentation Status' />
</a>
</div>
----
# Blender Soft Arm
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](https://www.blender.org/).
## How to install
Easiest way to install the stable version of the package is to use `pip`:
```sh
pip install bsr
```
## Examples
We provide minimal [example scripts](.examples) 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`](https://python-poetry.org/) to manage the dependencies and the development environment.
Necessary commands are provided in the `Makefile`.
```sh
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
```sh
cd docs
make clean
make html
open build/html/index.html
```
- Unittests
```sh
make test
```
- Code formatting
```sh
make formatting
```
- Check type-hinting
```sh
make mypy
```
Raw data
{
"_id": null,
"home_page": null,
"name": "bsr",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": null,
"keywords": "data-analysis",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0f/6a/63f50522fba8af3926557b7f2e2af96c86c67f6486b7f4d6db8a3706945b/bsr-0.1.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<h1> Blender Soft Arm </h1>\n\n<img src=\"https://img.shields.io/badge/Python-3776AB?style=flat&logo=Python&logoColor=white\"/>\n<a href='https://blender-soft-rod.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/blender-soft-rod/badge/?version=latest' alt='Documentation Status' />\n</a>\n\n</div>\n\n----\n# Blender Soft Arm\n\nThe Blender Soft Arm (bsr) includes data visualization tools and analysis for soft-arm robotics data.\nThe slender body is defined by a series of points and radius, and the data is visualized in [Blender](https://www.blender.org/).\n\n## How to install\n\nEasiest way to install the stable version of the package is to use `pip`:\n\n```sh\npip install bsr\n```\n\n## Examples\n\nWe provide minimal [example scripts](.examples) to demonstrate the usage of the package.\n\n## Development version\n\nThe development version includes unit-tests, documentation, examples, and other development tools.\nWe primarily use [`poetry`](https://python-poetry.org/) to manage the dependencies and the development environment.\nNecessary commands are provided in the `Makefile`.\n\n```sh\ngit clone https://github.com/GazzolaLab/Blender-Soft-Rod.git\ncd Blender-Soft-Rod\nmake install # Assuming you have poetry installed.\nmake pre-commit-install\n```\n\nBelow are additional commands that you can use to manage the development environment.\n\n- Documentation\n\n```sh\ncd docs\nmake clean\nmake html\nopen build/html/index.html\n```\n\n- Unittests\n\n```sh\nmake test\n```\n\n- Code formatting\n\n```sh\nmake formatting\n```\n\n- Check type-hinting\n\n```sh\nmake mypy\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Blender integration tools for soft-rod system.",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"data-analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e935353ad5b76207838186619e454e64adb6b5ab89c0ee1657480af4f4debcbc",
"md5": "c9032eed674b3716decb4aab53f873b2",
"sha256": "549f7f681411bf84fe272a5d11f702360a3834e67316934704dbf2d2f4e6b501"
},
"downloads": -1,
"filename": "bsr-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9032eed674b3716decb4aab53f873b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 14533,
"upload_time": "2024-06-22T21:53:12",
"upload_time_iso_8601": "2024-06-22T21:53:12.579141Z",
"url": "https://files.pythonhosted.org/packages/e9/35/353ad5b76207838186619e454e64adb6b5ab89c0ee1657480af4f4debcbc/bsr-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f6a63f50522fba8af3926557b7f2e2af96c86c67f6486b7f4d6db8a3706945b",
"md5": "6d8ab13d7d81b44a08468cfc6e336acd",
"sha256": "c892781fe6531ea0e37e9dc94a3d1f32318bb89c68de04bb14a71a21cfe1cde2"
},
"downloads": -1,
"filename": "bsr-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6d8ab13d7d81b44a08468cfc6e336acd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 11865,
"upload_time": "2024-06-22T21:53:13",
"upload_time_iso_8601": "2024-06-22T21:53:13.783671Z",
"url": "https://files.pythonhosted.org/packages/0f/6a/63f50522fba8af3926557b7f2e2af96c86c67f6486b7f4d6db8a3706945b/bsr-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-22 21:53:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bsr"
}
