Skip to content

Installation

Create a virtual environment

Install redsun in a virtual environment.

uv venv --python 3.11

# For Linux/macOS
source .venv/bin/activate

# For Windows Command Prompt
.venv\Scripts\activate.bat

# For Windows PowerShell
.venv\Scripts\Activate.ps1

# Python version depends on the globally installed Python
python -m venv redsun-env

# For Linux/macOS
source redsun-env/bin/activate

# For Windows Command Prompt
redsun-env\Scripts\activate.bat

# For Windows PowerShell
redsun-env\Scripts\Activate.ps1

conda create -n redsun-env python=3.11
conda activate redsun-env

mamba create -n redsun-env python=3.11
mamba activate redsun-env

Install Redsun

Install from PyPI or from the GitHub repository.

pip install -U redsun

# Or if you're using uv
uv pip install redsun

git clone https://github.com/redsun-acquisition/redsun.git
cd redsun
pip install -e .

Qt backend

redsun needs a Qt binding. Install the one you prefer:

pip install redsun[pyqt]

pip install redsun[pyside]

Install development dependencies

To contribute or run the tests, install the development dependencies from the PEP-735 dependency groups.

uv sync

pip install -e . --group dev

The checks run through tox, which builds each environment from uv.lock:

uv run tox           # lint, both Qt type-checking legs, tests, docs
uv run tox -e tests

Run tests lists what each environment covers.