Installation#

Step 1 — Prepare the Environment#

Method A: In conda environment (Recommended)#

You can use conda to create a virtual environment with Python 3.11 for Tepkit.

conda create --name tepkit python=3.11
conda activate tepkit

If you have not installed it, check one of the following:

Method B: In native environment#

Cheak if you have installed Python, and check if the version is at least 3.11 by:

Step 2 — Install Tepkit#

Method A: Form PyPI (Recommended)#

pip install tepkit

Method B: From GitHub#

pip install git+https://github.com/TepLabCode/Tepkit.git

Method C: From Releases#

Download:
Go to the releases page, and download the latest released package:
tepkit-<version>.tar.gz
Extract:
Extract the package by command or any other tool you like.
( Example command: tar -xvf tepkit-*.tar.gz )
Install: Go to the extracted directory and install the package:
```
cd tepkit-*
pip install .
```

(Optional) Install All Dependencies#

By default, Tepkit will only install the basic dependencies,
so you may meet ModuleNotFoundError when running some commands or using some functions.

If you want to install all dependencies at once,
you can add the [all] option to the installation command, like:

pip install tepkit[all]

Step 3 — Test#

A. As a Command-line Interface (CLI)#

You can test if Tepkit is installed correctly by running the tepkit command in the console.

> tepkit

If you installed Tepkit in conda, you need to activate the environment before running the command:

> conda activate tepkit
> tepkit

B. As a Python Module#

You can test if Tepkit can be imported correctly by the following code in Python:

import tepkit

Installation

Contents