Skip to content
Open
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
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,35 @@ The full documtation can be found here: [https://toolkit-for-simulation-based-in

## Setup

We will use `pixi` to setup the environment for the workflow. The specifications are defined in the `pixi.toml` file. If `pixi` is not installed on your machine follow the instructions in [pixi seutp guide](https://pixi.sh/latest/installation/). Then proceed to install the environment with:
We will use `pixi` to setup the environment for the workflow. The specifications are defined in the `pixi.toml` file. If `pixi` is not installed on your machine follow the instructions in [pixi setup guide](https://pixi.sh/latest/installation/).

On Linux machines with CUDA-capable GPUs, install the GPU environment with:
```
pixi install -e nsbi-env-gpu
```
Currently the environment can only be built on machines with GPU.
The `nsbi-env-gpu` environment is restricted to `linux-64` and will fail on macOS.

On macOS, install the CPU environment instead:
```
pixi install -e nsbi-env
```

A jupyter kernel can then be created by running the command for the environment you installed:
```
pixi run -e nsbi-env python -m ipykernel install --user --name nsbi-env --display-name "Python (pixi: nsbi-env)"
```

A jupyter kernel can then be created by running:
For the Linux GPU environment:
```
pixi run -e nsbi-env-gpu python -m ipykernel install --user --name nsbi-env-gpu --display-name "Python (pixi: nsbi-env-gpu)"
```

For cloning this repo you may want to disable auto-replacing the LFS pointer files with the actual files as they're pretty large, use the following git clone command to do so:

```shell
GIT_LFS_SKIP_SMUDGE=1 git clone git@github.com:iris-hep/NSBI-workflow-tutorial.git --depth=1
```

## Introduction

Simulation-Based Inference (SBI) or Neural Simulation-Based Inference (NSBI) refers to set of statistical techniques that allow statistical inference directly using high-dimensional data. This circumvents the need to build low-dimensional summaries as is traditionally done and which can lose sensitive information.
Expand Down
Loading