Installation

Basic Install

pip install neuralfetch

Then verify it works:

import neuralset as ns

# List available studies
all_studies = ns.Study.catalog()
print(f"{len(all_studies)} studies available")

To run the example tutorials, also install neuralset with the tutorials extra:

pip install 'neuralset[tutorials]'

Developer Install

For active development or to try the latest features:

📦 uv (fast) 🐍 conda

Step 1: Create and activate a virtual environment:

uv venv .venv
source .venv/bin/activate

Step 2: Install neuralfetch in editable mode:

# from the repo root
uv pip install -e 'neuralfetch-repo/.'

Step 3: For strict type checking (optional):

uv pip install --config-settings editable_mode=strict -e 'neuralfetch-repo/.'

Step 4: Set up pre-commit hooks:

pre-commit install

Step 1: Create and activate a conda environment:

conda create -n neuralfetch python=3.12
conda activate neuralfetch

Step 2: Install pip and uv in the environment:

conda install pip
pip install uv

Step 3: Install neuralfetch in editable mode:

# from the repo root
uv pip install -e 'neuralfetch-repo/.'

Step 4: For strict type checking (optional):

uv pip install --config-settings editable_mode=strict -e 'neuralfetch-repo/.'

Step 5: Set up pre-commit hooks:

pre-commit install

← Overview Tutorials →