Install with uv

uv is a modern Python package manager and virtual environment tool. We favor installing with uv thanks to its speed and creation of lockfiles to ensure reproducible environments.

Warning

Please refer to the installing PyTorch section of uv documentation should you encounter issues running on GPU. In particular it may be necessary to install torch independently in the venv on Windows (see this section)

Using notebooks

Install juv in uv:
```
uv tool install juv
```

Add CAREamics to your notebook:

juv add my_notebook.ipynb "careamics[examples]"

Run the notebook:
```
juv run my_notebook.ipynb
```

Note

You can start with one of our example notebooks. These already have the dependencies declared (juv add).

Using a project

Start your project:
```
uv init my_project
cd my_project
```
Add CAREamics to your project:
```
uv add "careamics[examples]"
```

Note

You can start with one of our example notebooks or the getting started section.