VQkit 1.1 - INSTALLATION GUIDE
====================================

Requirement: Python 3.9 or newer.

FIRST INSTALLATION
------------------

    cd VQkit_v1.0_Software_Package

    python3 -m venv vqkit_env
    source vqkit_env/bin/activate

    python -m pip install --upgrade pip setuptools wheel
    python -m pip install --upgrade installable/vqkit-1.0-py3-none-any.whl

    hash -r
    python -m pip show vqkit
    which vqkit
    vqkit version
    vqkit

Expected:

    VQkit 1.1

HPC
---

Load a Python 3.9+ module first if required, for example:

    module load python/3.9.5

UPGRADE
-------

Activate your existing environment and install the newer wheel:

    source /path/to/vqkit_env/bin/activate
    cd VQkit_v1.0_Software_Package
    python -m pip install --upgrade --no-cache-dir         installable/vqkit-1.0-py3-none-any.whl
    hash -r
    vqkit version

If `which vqkit` still shows an old `~/.local/bin/vqkit`, remove or deactivate that old installation.

PACKAGE CONTENTS
----------------

installable/
    vqkit-1.0-py3-none-any.whl

developer_source/
    VQkit_v1.0_source.zip
    vqkit-1.0.tar.gz

documentation/
    Feature-specific documentation.


## Windows PowerShell installation

On Windows, use `python` or the Windows Python launcher `py`. The command `python3` is not always registered on Windows.

First check which command is available:

```powershell
python --version
```

If that is not recognized, try:

```powershell
py --version
```

Create and activate a virtual environment with one of these forms:

```powershell
python -m venv vqkit_env
.\vqkit_env\Scripts\Activate.ps1
```

or:

```powershell
py -m venv vqkit_env
.\vqkit_env\Scripts\Activate.ps1
```

Then install VQkit:

```powershell
python -m pip install --upgrade pip setuptools wheel
python -m pip install --upgrade .\installable\vqkit-1.0-py3-none-any.whl
vqkit version
vqkit
```

Expected version:

```text
VQkit 1.1
```

