How to Install RDEToolKit

Purpose

This guide explains the procedures for installing RDEToolKit in your Python environment. We provide multiple installation methods for both development and production environments.

Prerequisites

Before installing RDEToolKit, ensure that the following requirements are met:

• Python: Version 3.9 or higher
• pip: Latest version recommended
• Internet Connection: Required for downloading packages from PyPI

1
2

python --version
pip --version

Steps

1. Standard Installation

The most common installation method. Install the stable version from PyPI.

1

pip install rdetoolkit

1

pip install rdetoolkit

2. Installation with MinIO Support

If you plan to use object storage (MinIO) functionality, install additional dependencies.

1

pip install rdetoolkit[minio]

1

pip install rdetoolkit[minio]

3. Development Version Installation

To use the latest development version, install directly from the GitHub repository.

1

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

1

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

4. Installation in Virtual Environment

Steps for creating an isolated environment for each project.

1
2
3
4
5
6
7
8
9

# Create virtual environment
python -m venv rde_env

# Activate virtual environment
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.9

# Activate environment
conda activate rde_env

# Install RDEToolKit
pip install rdetoolkit

Verification

Verify that the installation completed successfully.

Installation Check

1
2

import rdetoolkit
print(rdetoolkit.__version__)

Expected output example:

1

1.2.3

Basic Functionality Test

1
2
3
4
5

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

# Verify that basic imports succeed
print("RDEToolKit installation successful!")

Troubleshooting

Common Issues and Solutions

Permission Error

1

ERROR: Could not install packages due to an EnvironmentError

Solution: Install at user level

1

pip install --user rdetoolkit

Dependency Conflicts

1

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

Solution: Use a virtual environment

1
2
3

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

Python Version Incompatibility

1

ERROR: Package 'rdetoolkit' requires a different Python

Solution: Upgrade to Python 3.9 or higher

Related Information

Next steps after installation completion:

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