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.12.tar.gz (100.4 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.12-py3-none-any.whl (122.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gemprf-0.1.12.tar.gz
Algorithm Hash digest
SHA256 b46919d5ef4e2af8e31b1a9da3f20ea663aeb86f715739d83e7de59d609c5865
MD5 a6f5b73e799dda2935990bd61e02c8f9
BLAKE2b-256 0388152a9b100de99487fc52cf148e11d62125f1df4700cbe1fb35dad8178dda

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gemprf-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 cb318efcdd9e73cb6b6cd1753ba960848d36b5f29e28ca8d5c880ac91df16b46
MD5 2b39d9e87af80007babbc6f1961a7792
BLAKE2b-256 8047965306589ad8d32421c416ab2576837421f8d27c1e466963d59d25bb1904

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