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://www.biorxiv.org/content/10.1101/2025.05.16.654560v1


Documentation

Full documentation is coming soon: https://gemprf.github.io/

For now, the paper above is the best reference for the mathematical and computational design.


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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gemprf-0.1.7.tar.gz
  • Upload date:
  • Size: 100.1 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.7.tar.gz
Algorithm Hash digest
SHA256 01f37882d581c6f4f6a518b614ce61c1125e7a0f8aaa43ce3d3319d5a4c63bb4
MD5 e1c38aae86412223119cf7068e63ddde
BLAKE2b-256 d2e03f955956d51e437bc8fadc26911eb07c507ec7788a6e1493c3cd4f8d1860

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gemprf-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 119.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 cb5cd1f90fec951b8f7fcf725603c72f083effbe9d83bc4eb1587fe672fb1ace
MD5 995aef691791be2f6116d46d971c607a
BLAKE2b-256 c1c9f0720c6c8f69dcc5d7e97142713de850a52c16b85054213cbc187b933c94

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