# Installation instructions

This package is intended to be used as a library, and should be installed into
a python environment and imported into the users own code.

Python includes a tool for creating environments called {py:mod}`venv`.
Anaconda is another alternative that is especially useful on Windows since it
does not only deal with Python dependencies but C/C++ dependencies and more.
Popular packages such as NumPy and OpenCV has non-Python deps that can be
managed using [Anaconda](https://www.anaconda.com/) or some other good package manager.

```{tip}
Anaconda is cross platform and solves a lot of dependency headaches. Together
with an IDE like VS Code (also cross platform and well suited for Python) is a
good starting point.

There is a very helpful guide to get started on VS Code's documentation website
titled
[Getting Started with Python in VS Code](https://code.visualstudio.com/docs/python/python-tutorial)
```

## Set up environment

### Using Anaconda

```bash
conda config --add channels conda-forge
conda create -n my_project python=3.10
conda activate my_project
```

### Using `virtualenv`

```bash
virtualenv --python=python3.8 {{path/to/venv}}
source {{path/to/venv}}/bin/activate
```

## Install package

### Latest release

```bash
pip install ur_py_ctl
```

### Latest commit

```bash
pip install git+https://gitlab.control.lth.se/robotlab/ur_py_ctl
```