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.10.tar.gz (104.0 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.10-py3-none-any.whl (124.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gemprf-0.1.10.tar.gz
  • Upload date:
  • Size: 104.0 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.10.tar.gz
Algorithm Hash digest
SHA256 c3fc2a779e2c1ea52009724125822f09a0b8546e40c7e4b2a8907df7f174c059
MD5 da4d6c410c93fe3f83ca185fd8136824
BLAKE2b-256 c15d235aa472d5c16a6731282c9e5a85f55e25dadcf32d34caa480155a64585c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gemprf-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 124.2 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 c10bc93346090e9b975e9a0af3d15c25b3aa65b0826af4e7dcefa467a3aa5bb9
MD5 b8d357fb819e7812d4e02f0af47eac2d
BLAKE2b-256 d10d89569f692b531ce3aa52f17214ac127f69a86dd465950ee5fd92ba066a10

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