Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
leoschwarz committed Nov 7, 2024
1 parent c423a4d commit 44ea73a
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 44ea73a

Please sign in to comment.