Installation Guide

Welcome to the installation guide for TensorHEOM. Follow the steps below to install the package, set up a virtual environment, and start using the Graphical User Interface.

Installation via PyPI

The easiest way to install TensorHEOM is through PyPI. For best results, we recommend creating a new virtual environment to avoid package conflicts.

Steps

Create a New Virtual Environment:

Open your terminal and navigate to your project folder. Run:
```
python -m venv .venv
```
Activate the Virtual Environment:
- Windows:
```
.venv\Scripts\activate
```
- macOS/Linux:
```
source .venv/bin/activate
```
Install the `TensorHEOM` Package:
```
pip install ttheom
```

Installation in editable mode via GitHub

If you plan to contribute to the development or make changes to the source code, install TensorHEOM in editable mode by cloning its GitHub repository.

Steps

Clone the GitHub Repository:

git clone https://github.com/dehe1011/TensorHEOM.git

Navigate to the Cloned Repository:
```
cd TensorHEOM
```
Run the Activation Script:

Use the provided activation script to complete the installation. Instructions vary by platform (see below).

Platform-Specific Instructions for Activation

Windows

Navigate to the project directory:

Set-Location -Path "C:\Users\<YourUsername>\TensorHEOM"

Run the activation script:

powershell -ExecutionPolicy Bypass -File scripts\Activate.ps1

macOS

Navigate to the project directory:
```
cd /Users/<YourUsername>/TensorHEOM
```
Run the activation script:
```
source scripts/activate
```

Linux

Navigate to the project directory:
```
cd /home/<YourUsername>/TensorHEOM
```
Run the activation script:
```
source scripts/activate
```

Uninstallation

To remove the package:

pip uninstall TensorHEOM

If you cloned the GitHub repository, manually delete the TensorHEOM folder from your computer.