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
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ parameter inference techniques based on [sbi](https://sbi-dev.github.io/sbi)) wi
inverse modelling pipeline. Designed for modularity, it adapts to your needs without constraints.


# Installation
# Installation on Linux

`ncpi` requires Python 3.10 or higher. To install `ncpi`, you can use pip. The package is available on PyPI, so you can
install it directly from there.
Expand Down Expand Up @@ -73,6 +73,31 @@ pip uninstall scikit-learn numpy -y
pip install scikit-learn==1.5.0 numpy
```

# Installation on Windows

To be able to install all dependencies of `ncpi` in Windows, first you have to install [Windows Subsystem for Linux (WSL)](https://documentation.ubuntu.com/wsl/stable/howto/install-ubuntu-wsl2/).

After the WSL installation, we strongly recommend to install the latest updates by running the following commands within the Ubuntu terminal:

```bash
$ sudo apt update
$ sudo apt upgrade -y
```

Once Ubuntu is up and running in WSL, [conda can be installed there](https://docs.conda.io/projects/conda/en/stable/user-guide/install/linux.html). Now you can follow the rest of the instructions of the [installation of `ncpi` in Linux](#Installation-on-Linux).

If you encounter the error *Failed building wheel for pycatch22* when installing `pip install ncpi`, install:

```bash
$ conda install -c conda-forge pycatch22
```

If the error still persists, install the following dependencies:

```bash
$ sudo apt install -y build-essential python3-dev
```

# Folder Structure

- `ncpi/`: Contains the source code for the library, organized into modules and classes.
Expand Down
Loading