Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 3 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Eye-to-hand calibration from RGB-D images using robot mesh as calibration target
## Table of Contents
- [Installation](#installation)
- [Pip (Requires CUDA Toolkit Installation)](#pip-requires-cuda-toolkit-installation)
- [Conda (Installs CUDA Toolkit)](#conda-installs-cuda-toolkit)
- [Docker (Comes with CUDA Toolkit)](#docker-comes-with-cuda-toolkit)
- [Command Line Interface](#command-line-interface)
- [Segment](#segment)
Expand All @@ -35,44 +34,20 @@ Eye-to-hand calibration from RGB-D images using robot mesh as calibration target
- [Testing](#testing)

## Installation
Three install options are provided:
Two install options are provided:
- [Pip (Requires CUDA Toolkit Installation)](#pip-requires-cuda-toolkit-installation)
- [Conda (Installs CUDA Toolkit)](#conda-installs-cuda-toolkit)
- [Docker (Comes with CUDA Toolkit)](#docker-comes-with-cuda-toolkit)

### Pip (Requires CUDA Toolkit Installation)
> [!NOTE]
> During runtime, CUDA Toolkit is required for the differentiable rendering. If you are planning to do differentiable rendering, see [CUDA Toolkit Install Instructions](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/). Alternatively, install using `conda`, see [Conda (Installs CUDA Toolkit)](#conda-installs-cuda-toolkit).
> During runtime, CUDA Toolkit is required for the differentiable rendering. If you are planning to do differentiable rendering, see [CUDA Toolkit Install Instructions](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/).

To `pip` intall `roboreg`, simply run

```shell
pip3 install roboreg
pip install roboreg
```

### Conda (Installs CUDA Toolkit)
To install `roboreg` within an [Anaconda](https://www.anaconda.com/) environment (ideally [Miniconda](https://docs.anaconda.com/miniconda/), or even better, [Mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html)), do the following:

1. Create an environment

```shell
conda create -n rr-0.4.6 python=3.10
```

2. Clone this repository and install dependencies

```shell
git clone git@github.com:lbr-stack/roboreg.git
mamba env update -f roboreg/env.yaml # if Anaconda or Miniconda was used, do 'conda env update -f env.yaml'
```

3. Install `roboreg`

```shell
mamba activate rr-0.4.6 # can also use 'conda activate rr-0.4.6' in either case
pip3 install roboreg/
```

### Docker (Comes with CUDA Toolkit)
A sample Docker container is provided for testing purposes. First:

Expand Down
27 changes: 0 additions & 27 deletions env.yaml

This file was deleted.

Loading