How to Install RDEToolKit

Purpose

This guide explains the procedures for installing RDEToolKit in your Python environment. Multiple installation methods are provided for both development and production use.

Prerequisites

Before installing RDEToolKit, confirm the following:

• Python: Version 3.10 or higher
• pip: Latest version recommended
• Internet Connection: Needed to download packages from PyPI

1
2

python --version
pip --version

Steps

1. Standard Installation

Install the stable release from PyPI.

1

pip install rdetoolkit

1

pip install rdetoolkit

2. Installation with MinIO Support

Install extra dependencies if you use object storage (MinIO).

1

pip install 'rdetoolkit[minio]'

1

pip install 'rdetoolkit[minio]'

3. Installation with Plotly Support

Plotly is a visualization library that generates interactive graphs and dashboards (operable dynamically in a web browser). Install extras if you need Plotly features in RDEToolKit.

1

pip install' rdetoolkit[plotly]'

1

pip install 'rdetoolkit[plotly]'

4. Development Version Installation

Install the latest development version directly from GitHub.

1

pip install git+https://github.com/nims-mdpf/rdetoolkit.git

1

pip install git+https://github.com/nims-mdpf/rdetoolkit.git

5. Installation in a Virtual Environment

Create an isolated environment per project.

1
2
3
4
5
6
7
8
9

# Create virtual environment
python -m venv rde_env

# Activate
source rde_env/bin/activate  # Unix/macOS
# rde_env\Scripts\activate   # Windows

# Install RDEToolKit
pip install rdetoolkit

1
2
3
4
5
6
7
8

# Create new environment
conda create -n rde_env python=3.10

# Activate
conda activate rde_env

# Install RDEToolKit
pip install rdetoolkit

Verification

Installation Check

1
2

import rdetoolkit
print(rdetoolkit.__version__)

Expected example:

1

1.2.3

Basic Functionality Test

1
2
3
4

from rdetoolkit import workflows
from rdetoolkit.models.rde2types import RdeInputDirPaths, RdeOutputResourcePath

print("RDEToolKit installation successful!")

Troubleshooting

Dependency Conflicts

1

ERROR: pip's dependency resolver does not currently take into account all the packages

Solution: Use a clean virtual environment

1
2
3

python -m venv clean_env
source clean_env/bin/activate
pip install rdetoolkit

Related Information

Next steps:

• Quick Start - Run your first structured processing
• Configuration File - Customize behavior settings
• API Reference - Detailed feature descriptions