Skip to main content

A Python library for population receptive field (pRF) analysis

Project description

GEM-pRF

Welcome to GEM-pRF, a standalone, GPU-accelerated tool for population receptive field (pRF) mapping, built for large-scale fMRI analysis.

For theory and full method details, see our paper:

👉 Mittal et al. (2025): GEM-pRF: GPU-Empowered Mapping of Population Receptive Fields for Large-Scale fMRI Analysis https://doi.org/10.1016/j.media.2025.103891

Documentation

  • Documentation and examples are available at: https://gemprf.github.io/

  • For a deeper look into the mathematical and computational foundations, the paper above is the best reference.

Installation

GEM-pRF relies on an NVIDIA GPU and CUDA. Make sure your system has:

  • A compatible NVIDIA GPU
  • A matching CUDA toolkit
  • A matching NVCC compiler

1. Install GEM-pRF

pip install gemprf

Latest versions: https://pypi.org/project/gemprf/

2. Install CuPy (required)

GEM-pRF depends on CuPy, but CuPy must match your CUDA version — so it is not installed automatically.

Install the correct CuPy wheel for your system:

pip install cupy-cuda12x

[!Caution] Install the CuPy variant that matches your CUDA version.

You must install CuPy before running GEM-pRF.

Running GEM-pRF

After installing gemprf and a compatible CuPy build, you can run GEM-pRF directly from Python.

Example

import gemprf as gp

gp.run("path/to/your_config.xml")

Configuration files

GEM-pRF uses XML configuration files to define analysis settings. See a sample config here:

https://github.com/siddmittal/GEMpRF_Demo/blob/main/sample_configs/sample_config.xml


Quick workflow

  1. Install GEM-pRF → pip install gemprf

  2. Install the correct CuPy for your CUDA environment

  3. Prepare your XML config file

  4. Run:

    import gemprf as gp
    gp.run("config.xml")
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gemprf-0.1.11.tar.gz (105.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gemprf-0.1.11-py3-none-any.whl (127.3 kB view details)

Uploaded Python 3

File details

Details for the file gemprf-0.1.11.tar.gz.

File metadata

  • Download URL: gemprf-0.1.11.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for gemprf-0.1.11.tar.gz
Algorithm Hash digest
SHA256 dab696ef86b0dfde7ff8ec3492705ba18ad2c49f1713faedfb45919e167bb219
MD5 4c0ee3d2af3d37945372ac0e487cb3dc
BLAKE2b-256 beec356a6308f594e57d37c2b2c601984083acc4c675766f4adc220307bb707d

See more details on using hashes here.

File details

Details for the file gemprf-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: gemprf-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 127.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for gemprf-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 2ca31a1785e1a6147505f1245e225a91dc496276f865b98eb428a976347e668c
MD5 a3b541bec33b4ee832c8d6725a3bb98a
BLAKE2b-256 e3fca5ee31e09e8d0e964f6adc26513254b329fae8cac6e23329d21684873f3f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page