Skip to content

Commit 393860f

Browse files
committed
Add CLI-phobos
* codemeta.json, setup.py and README are updated accordingly * CLI-phobos is published under BSD-3 as well * CLI-phobos was developed by Julius Martensen & Henning Wiedemann and is moved from another repository * From here on we start developing version 2.0.0
1 parent 124f87e commit 393860f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+11987
-196
lines changed

README.md

+31-3
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://gith
99

1010
![Phobos](https://github.com/dfki-ric/phobos/wiki/img/phobos_logo_small.png)
1111

12-
Phobos is an add-on for the open-source 3D modeling software
13-
[Blender](http://www.blender.org) that enables the creation of WYSIWYG robot
12+
Phobos is both a CLI tool and add-on for the open-source 3D modeling software
13+
[Blender](http://www.blender.org) to support your robot model creation and editing
14+
15+
The Blender add-on enables the creation of WYSIWYG robot
1416
models for use in robot frameworks like [ROS](http://wiki.ros.org/) and
1517
[ROCK](https://github.com/rock-core) or in real-time simulations such as
1618
[MARS](https://github.com/rock-simulation/mars) or
@@ -25,7 +27,8 @@ Bremen, together with the [Robotics
2527
Group](http://www.informatik.uni-bremen.de/robotik/index_en.php) of the
2628
[University of Bremen](http://www.uni-bremen.de/en.html).
2729

28-
Please contact [Kai von Szadkowski](https://robotik.dfki-bremen.de/de/ueber-uns/mitarbeiter/kavo01.html)
30+
Please contact [Kai von Szadkowski](https://robotik.dfki-bremen.de/de/ueber-uns/mitarbeiter/kavo01.html) or
31+
[Henning Wiedemann](https://robotik.dfki-bremen.de/de/ueber-uns/mitarbeiter/hewi04.html)
2932
for any inquiries, or any questions and feedback not suited for the issues
3033
page.
3134

@@ -49,10 +52,28 @@ If you are on the hunt for a BiBTeX entry, check out the [FAQ section](https://g
4952

5053
## Installation
5154

55+
### Blender
5256
Just zip the `phobos` subfolder: `zip -r phobos.zip phobos` and install it via Blender: `blender->edit->preferences->addons->install`
5357

58+
### CLI
59+
Just install it using pip:
60+
```bash
61+
cd phobos
62+
pip install .
63+
```
64+
or without pip:
65+
```bash
66+
cd phobos
67+
python setup.py install
68+
```
69+
or with autoproj:
70+
1) Add the package to your buildconf/package_set
71+
2) Install via `amake`
72+
5473
## Overview
5574

75+
### Blender
76+
5677
![Model of the SpaceClimber robot in Blender, next to the Phobos toolbar
5778
displayed on the
5879
left.](https://github.com/dfki-ric/phobos/wiki/img/phobos_spaceclimber.png)
@@ -83,10 +104,17 @@ in Blender.](https://github.com/dfki-ric/phobos/wiki/img/phobos_elements.png)
83104
in Blender. These elements can be arranged in Blender on different layers, thus
84105
avoiding confusion or obstruction of view when editing very complex models.*
85106

107+
### CLI
108+
109+
You can either use CLI-phobos as a normal python package or use the scripts provided with it.
110+
111+
For the latter do `phobos --help` to get a list of the currently available scripts.
112+
It will also tell you which dependencies are missing for some scripts.
86113

87114
## Features
88115

89116
- WYSIWYG editor for robot models using Blender
117+
- CLI tool for automated model processing
90118
- Import and export of **URDF**, **SDF** **SMURF** and other
91119
[formats](https://github.com/dfki-ric/phobos/wiki/Formats)
92120
- Easy definition of robot kinematics (links and joints)

TODO.md

+3
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ should work. However, there are still a few todos left:
1919
- drawing into 3d_view via opengl
2020
- collect all issues
2121
- update add motor and controller operator to not create new objects
22+
- [done] autmatic installation of python dependencies in blender
23+
- fully integrate cli-phobos starting with io
24+
- make compatible with blender3

codemeta.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"@type": "Code",
44
"author": [
55
Kai von Szadkowski,
6+
Henning Wiedemann
67
Simon Reichel,
78
Julius Martensen
89
],
@@ -11,9 +12,9 @@
1112
"datePublished": "2019-02-01",
1213
"dateModified": "2020-12-16",
1314
"dateCreated": "2019-02-01",
14-
"description": "A Blender addon to create and edit robot models in a WYSIWYG environment.",
15-
"keywords": "robotics, Blender, Python, URDF, SDF, model",
15+
"description": "A Blender addon to create and edit robot models in a WYSIWYG environment and a python package/CLI tool to do this automated.",
16+
"keywords": "robotics, Blender, Python, URDF, SDF, model, MARS, SMURF, CLI, python, package",
1617
"license": "BSD-3-Clause",
1718
"title": "Phobos",
18-
"version": "1.0.1"
19+
"version": "2.0.0"
1920
}

phobos/__init__.py

-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ def import_submodules(package, recursive=True, verbose=False):
109109
print("Checking requirements")
110110
requirements = {
111111
"yaml": "pyyaml",
112-
# "urdf_parser_py": "urdf_parser_py",
113112
# "networkx": "networkx", # optional for blender
114113
"numpy": "numpy",
115114
# "pybullet": "pybullet", # optional for blender

phobos/ci/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from .pipeline import Pipeline, TestingPipeline, XTypePipeline

0 commit comments

Comments
 (0)