Installing CAREamics with uv#

Important

Please refer to the installing PyTorch section of uv documentation should you encounter issues running on GPU.

Using notebooks#

To run notebooks, install juv:

Installing juv

uv tool install juv

CAREamics-examples contains multiple notebook examples that can be directly run with uv:

Run a notebook

juv run notebook.ipynb

To run your own notebook, we recommend adding PEP723 metadata:

Add CAREamics dependency

juv add my_notebook.ipynb "careamics[examples]"
juv run my_notebook.ipynb

You can also pin the CAREamics dependency in order to improve reproducibility:

Pin CAREamics dependency

juv add my_notebook.ipynb "careamics[examples]==0.0.16"

In this section, we will describe creating a project with CAREamics as a dependency, using standard uv:

uv init careamics_project
cd careamics_project
uv add "careamics[examples]>=0.0.16"  # (1)!