Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,32 @@ Originally designed for the fields of tomography and phase retrieval, GANrec shi

# Installation

This guide provides detailed steps for setting up the `ganrec` package in a Conda environment.
This guide provides two ways to set up `ganrec`:
- With Pixi (recommended, reproducible): default TensorFlow+CUDA backend with an optional PyTorch-only backend.
- With Conda/pip (alternative): manual setup.

## Pixi (recommended)

Pixi manages environments and dependencies declaratively via `pyproject.toml`.

- Default backend (TensorFlow with CUDA extras):

```bash
pixi install
pixi run python -c "import tensorflow as tf; print(tf.__version__)"
```

- Optional PyTorch backend (no TensorFlow):

```bash
pixi -e pytorch install
pixi -e pytorch run python -c "import torch; print(torch.__version__)"
```

Notes:
- The default Pixi environment installs TensorFlow with GPU support (via pip extra) and does not install PyTorch.
- The `pytorch` Pixi environment installs PyTorch-only and does not install TensorFlow.
- `ipython`/`ipykernel` are included so you can create a kernel for notebooks if needed.

## Steps for General Users

Expand Down
Binary file modified examples/test_results/recon_tooth.tiff
Binary file not shown.
29 changes: 12 additions & 17 deletions examples/tomography_tf.ipynb

Large diffs are not rendered by default.

Loading