Installation for Developers¶

Cloning the Repository¶

For development, you need the source code. Clone the repository by executing

git clone https://github.com/famura/binned-cdf.git

uv¶

This project is managed by uv, an extremely fast Python package and project manager, written in Rust. This means, however, that uv needs to be installed before you can run the CLI or install the development version. The official uv installation docs show several ways to install []uv]uv on different platforms and under different conditions.

Installation for the lazy ones

This is just a quick tip on installing uv, better see the official uv docs

via curl on macOS & Linux (recommended)via conda (not recommended)

Run

curl -LsSf https://astral.sh/uv/install.sh | sh

conda activate <some-environment>
conda install pip
pip install pipx
pipx install uv
conda deactivate

Managing Python¶

With uv, you can install a suitable python version by running

uv python install

to install the latest stable Python version. See the uv docs for more details.

Actual Installation¶

The final project installation should be easy. Run this from the projects root level:

uv sync

No project development intended?

If you don't need any development setup, you can add the --no-dev flag to skip development dependencies.

Computer says no…

In some cases, this does not work right away. Please create and issue such that we can collect failure cases and hints to their solution here.

What?	Hint
placeholder issue	placeholder hint