Installation Guide

Welcome to the installation guide for QuantumDNA. Follow the steps below to install the package, set up a virtual environment, and start using qDNA either through a Graphical User Interface or a Jupyter Notebook.

Prerequisites

Before proceeding, make sure the following prerequisites are met:

Python Installation:
- Verify that Python is installed by running:
```
python --version
```
- If Python is not installed, download and install it from python.org.
Linux/macOS Users:
- Ensure pip and tkinter are installed:
```
python3 -m pip --version
python3 -m tkinter
```
- If they are not installed, install them using your package manager:
Windows Users:
- Ensure Git is installed by running:
```
git --version
```
- If Git is not installed, download and install it from Git for Windows.

Installation via PyPI

The easiest way to install qDNA is through PyPI. 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 `qDNA` Package:
```
pip install qDNA
```
Optional: Use `qDNA` Inside a Jupyter Notebook:

Install Jupyter and launch the notebook:
```
pip install ipykernel notebook
jupyter notebook
```

Installation via Cloning the GitHub Repository

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

Steps

Clone the GitHub Repository:

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

Navigate to the Cloned Repository:
```
cd QuantumDNA
```
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>\QuantumDNA"

Run the activation script:

powershell -ExecutionPolicy Bypass -File scripts\Activate.ps1

macOS

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

Linux

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

Post-Installation and Usage

If all tests pass, the package has been successfully installed! You can now:

Launch the Graphical User Interface or
Start using qDNA inside a Jupyter Notebook.

Run the activation script as mentioned in the platform-specific instructions to start the Graphical User Interface or a Jupyter Notebook. It is recommended to always run the activation script.

Uninstallation

To remove the package:

pip uninstall qDNA

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

Congratulations! You’ve successfully installed and set up QuantumDNA.