Installation#

Install the package using pip, or download the source code from GitHub.

Prerequisites#

  • Python 3.12 or higher is required.

  • It is recommended to install PyKP within a virtual environment to manage dependencies and avoid conflicts.

Setting Up a Virtual Environment#

If you haven’t already, create and activate a virtual environment:

On macOS/Linux:

python3 -m venv venv
source venv/bin/activate

On Windows:

python -m venv venv
venv\\Scripts\\activate

Install using pip#

Install the latest released version from the Python Package Index PyPi:

pip install pykp

Install a local copy#

To install the latest version of PyKP directly from GitHub, clone the repository and install it in “editable” mode. This allows you to make changes to the source code and see them immediately reflected.

  1. Optional: fork the repository .

    If you don’t want to merge your changes with the original repository, you can skip this step.

  2. Clone the repository:

    • If you forked the repository, run:

      Replace GITHUB_USERNAME with your GitHub username.

    • If you didn’t fork the repository, clone the original repository:

      git clone https://github.com/yourusername/pykp.git

  3. Install PyKP in editable mode:

    pip install --editable .

This will install PyKP along with all necessary dependencies.