Installation

Prerequisites

• Conda (Miniconda or Anaconda for instance)

Quick Install

1. Clone the repository

git clone https://github.com/sebllns/kmhelpers
cd kmhelpers

To clone a specific version tag directly:

git clone --branch v0.6.3 https://github.com/sebllns/kmhelpers
cd kmhelpers

2. Create the Conda environment

conda env create -f conda/environment.yml -p ./.env

This installs kmindex, ntcard, and all Python dependencies into a local .env directory.

3. Activate the environment

conda activate ./.env

Note

Run this activation command each time you open a new terminal session before using kmhelpers.

Tip

You can install to a permanent location instead:

conda env create -f conda/environment.yml -p ~/.kmhelpers
conda activate ~/.kmhelpers

4. Verify

kmhelpers --version
kmhelpers --help

Verify dependencies:

kmindex --version
kmtricks --version
ntcard --version

Updating

git pull origin main

To pull from a specific branch:

git pull origin release/v0.6.3

To check out a specific tag instead:

git fetch --tags
git checkout v0.6.3

Then verify the installed version:

kmhelpers --version