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

:::warning 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.6.tar.gz (100.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.6-py3-none-any.whl (119.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gemprf-0.1.6.tar.gz
  • Upload date:
  • Size: 100.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.6.tar.gz
Algorithm Hash digest
SHA256 a716f037ba4fa167f12e4e1a9c8903cf80ca2d42554aef65387b64c39b0e6cc4
MD5 47b6d435d75de173ae752d6b3694e7f3
BLAKE2b-256 e968c7cbef687fe648fde699ea277c17c9a2c858844354656a665a930c88c5c1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gemprf-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 119.4 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c5c350bbf317aaead05d408473310320ffe29f15d1c3e8a641b6257d0189614b
MD5 cf7ccf8951c17c23ba9f4e4f50263bb0
BLAKE2b-256 121b772c57d1217fb22d79acb0613eb196c90ed5acf6a78be6db68e19801b00b

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