Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #5

Merged
merged 2 commits into from
Jul 14, 2022
Merged

Update installation instructions #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d12f03c
Update installation instructions
IsabelParedes Jul 11, 2022
6d2e1fc
Remove blank line
IsabelParedes Jul 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Examples

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.
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.

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

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:
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:

- `jupyterlab-ros`
- `ros-noetic-urdf-tutorial`
- `ros-noetic-turtlebot3-description`

Expand Down
24 changes: 24 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@

- JupyterLab >= 3.0

For running the examples and interfacing with ROS, the following packages are also required:

- `jupyterlab-ros`
- `ros-noetic-urdf-tutorial`
- `ros-noetic-turtlebot3-description`

These packages can be installed with `conda` from the RoboStack channel.

## Install

To install the extension, execute:

1. `conda install jupyterlab-urdf -c conda-forge` or
2. `pip install jupyterlab-urdf` or
3. `npm i jupyterlab_urdf`

## Uninstall

To remove the extension, execute:

1. `conda remove jupyterlab-urdf` or
2. `pip uninstall jupyterlab-urdf` or
3. `npm uninstall jupyterlab_urdf`

## Development install

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