Skip to content

Installation

This guide covers how to install redsun in different environments.

Create a virtual environment

It is recommended to install the package in a virtual environment.

uv venv --python 3.10

# 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.10
conda activate redsun-env

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

Install Redsun

The package is available on PyPI or directly 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 requires a Qt backend. Install with your preferred binding:

pip install redsun[pyqt]

pip install redsun[pyside]

Install development dependencies

If you are contributing to redsun or want to run tests locally, install the development dependencies via PEP-735 dependency groups.

uv sync

pip install -e .[dev]