Skip to content

BabaSanfour/Coord2Region

Coord2Region

Codecov Tests Documentation Status Preprint License: BSD-3-Clause

Coord2Region maps 3D brain coordinates to anatomical regions, retrieves related studies, and uses large language models to summarize findings or generate images.

Features

  • Automatic anatomical labeling across multiple atlases
  • LLM-powered summaries of nearby literature
  • Coordinate-to-study lookups via Neurosynth, NeuroQuery, etc.
  • AI-generated region images
  • Command-line and Python interfaces

Installation

Requires Python 3.10 or later. We recommend installing in a virtual environment:

python -m venv .venv
source .venv/bin/activate
pip install coord2region

To work on Coord2Region itself, install the optional dependencies:

pip install '.[dev]'    # linting and tests
pip install '.[docs]'   # documentation build

On shells like zsh, keep the extras spec in quotes to avoid glob expansion errors.

Set environment variables like OPENAI_API_KEY or GEMINI_API_KEY to enable LLM-based features.

Example

coord2region coords-to-atlas 30 -22 50 --atlas harvard-oxford

Other use cases:

  • coord2region coords-to-summary 30 -22 50 → text summary from related studies
  • coord2region coords-to-image 30 -22 50 → AI-generated region image

Full usage instructions and API details are available in the documentation.

Links

About

Open-source Python package mapping 3D brain coordinates to regions across atlases, with batch query and meta-analysis support.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages