From 44ea73a8632d50c5446e9074590d1a65cb281d3e Mon Sep 17 00:00:00 2001 From: Leonardo Schwarz Date: Thu, 7 Nov 2024 10:25:26 +0100 Subject: [PATCH] update installation instructions --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c80ea32..e3952b5 100644 --- a/README.md +++ b/README.md @@ -15,24 +15,22 @@ This project is in an early state of development. If you are interested, it's be Currently, Python 3.12 is required, 3.13 is not compatible yet (missing wheels and e.g. llvmlite). -### Using `uv` (recommended) +### Install `uv` -Install the `pyproject.toml` in editable mode, tested with -[uv](https://github.com/astral-sh/uv): +The application [uv](https://github.com/astral-sh/uv) provides both very fast installation of all required dependencies, as well as functionality to install a particular version of Python for you. -```bash -uv venv -uv pip install -e ".[dev]" -``` +If you do not have `uv` installed yet, please consult their [installation instructions](https://docs.astral.sh/uv/getting-started/installation/). -### Using `conda` +To create a virtual environment using `uv` and install depiction in editable mode (i.e. changes to code are immediately available in the environment), run the following commands: ```bash -conda create -n exp-2024-05-depiction python=3.11 -conda activate exp-2024-05-depiction -pip install -e ".[dev]" +uv venv -p 3.12 +uv pip install -e ".[dev]" ``` +This creates the virtual environment in the `.venv` directory. +To activate the environment in your shell, you need to `source` the correct activation script from `.venv/bin`, e.g. `.venv/bin/activate` for bash. + ## Geometry Conventions TODO these are not used consistently everywhere yet