Installation

This section describes how to install tdcpy using pip or from source. It is recommended to install the package inside a virtual environment.

Prerequisites

• Python 3.10 or newer

• pip installed

Creating a virtual environment

First, create and activate a virtual environment.

On Linux and macOS:

python -m venv venv
source venv/bin/activate

On Windows:

python -m venv venv
venv\Scripts\activate

Once activated, your shell prompt should indicate that the virtual environment is active.

Installing with pip

The easiest way to install tdcpy is via pip:

pip install tdcpy

To upgrade to the latest version:

pip install --upgrade tdcpy

Installing from source

To install tdcpy from source, clone the GitHub repository:

git clone https://github.com/LockeErasmus/tdcpy.git
cd tdcpy

Install the package using pip:

pip install .

For development purposes, install the package in editable mode:

pip install -e .