Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 1.68 KB

INSTALL.md

File metadata and controls

61 lines (43 loc) · 1.68 KB
Raw

Installing RDT

Requirements

RDT has been developed and tested on Python 3.8, 3.9, 3.10, 3.11 and 3.12

Also, although it is not strictly required, the usage of a virtualenv is highly recommended in order to avoid interfering with other software installed in the system where RDT is run.

Install with pip

The easiest and recommended way to install RDT is using pip:

pip install rdt

This will pull and install the latest stable release from PyPi.

Install with conda

RDT can also be installed using conda:

conda install -c sdv-dev -c conda-forge rdt

This will pull and install the latest stable release from Anaconda.

Install from source

If you want to install RDT from source you need to first clone the repository and then execute the make install command inside the stable branch. Note that this command works only on Unix based systems like GNU/Linux and macOS:

git clone https://github.com/sdv-dev/RDT
cd RDT
git checkout stable
make install

Install for development

If you intend to modify the source code or contribute to the project you will need to install it from the source using the make install-develop command. In this case, we recommend you to branch from main first:

git clone git@github.com:sdv-dev/RDT
cd RDT
git checkout main
git checkout -b <your-branch-name>
make install-develp

For more details about how to contribute to the project please visit the Contributing Guide.