Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,17 @@ This guide provides instructions for installing Jecq on Linux and Windows. You c
## Option 1: Install from Pre-built Wheels (Recommended)
This is the easiest way to install the Jecq Python package. Pre-built wheels are included with each release.

- Ensure a Python 3.12 environment is activated, for example via [miniconda](https://www.anaconda.com/docs/getting-started/miniconda/main).
- Ensure a Python 3.12 environment is activated, for example via [miniconda](https://www.anaconda.com/docs/getting-started/miniconda/main):
```sh
conda create -n jecq_test python=3.12 -c conda-forge
conda activate jecq_test
```

- Download the `.whl` wheel file for your platform from the [latest release](https://github.com/JaneaSystems/jecq/releases/latest).
- Install the wheel via pip:

- Install the wheel via `pip`:
```sh
pip install <path_to_wheel>
pip install <path_to_downloaded_wheel>
```

## Option 2: Build from Source
Expand Down