Skip to content

Commit 6bacbb9

Browse files
Merge pull request #5 from ihuicatl/docs
Update installation instructions
2 parents cb28492 + 6d2e1fc commit 6bacbb9

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

docs/examples.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Examples
22

3-
Without any configuration, the basic robot example can be displayed in the viewer. This robot is simmply two geometric components with a single prismatic joint.
3+
Without any configuration, the basic robot example can be displayed in the viewer. This robot is simply two geometric components with a single prismatic joint.
44

55
![Basic Robot](_static/exBasic.png)
66

7-
To display the basic Niryo and the Burger robot, a ROS environment needs to be configured accordingly in order for the viewer to locate the necessary mesh files. The following ROS packages are required:
7+
To display the basic Niryo and the Burger robot, a ROS environment needs to be configured accordingly in order for the viewer to locate the necessary mesh files. The following packages are required:
88

9+
- `jupyterlab-ros`
910
- `ros-noetic-urdf-tutorial`
1011
- `ros-noetic-turtlebot3-description`
1112

docs/installation.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,30 @@
44

55
- JupyterLab >= 3.0
66

7+
For running the examples and interfacing with ROS, the following packages are also required:
8+
9+
- `jupyterlab-ros`
10+
- `ros-noetic-urdf-tutorial`
11+
- `ros-noetic-turtlebot3-description`
12+
13+
These packages can be installed with `conda` from the RoboStack channel.
14+
15+
## Install
16+
17+
To install the extension, execute:
18+
19+
1. `conda install jupyterlab-urdf -c conda-forge` or
20+
2. `pip install jupyterlab-urdf` or
21+
3. `npm i jupyterlab_urdf`
22+
23+
## Uninstall
24+
25+
To remove the extension, execute:
26+
27+
1. `conda remove jupyterlab-urdf` or
28+
2. `pip uninstall jupyterlab-urdf` or
29+
3. `npm uninstall jupyterlab_urdf`
30+
731
## Development install
832

933
**Note:** You will need NodeJS to build the extension package.

0 commit comments

Comments
 (0)