Documentation#
Note
New to Coord2Region? Start with the Install guide.
If you are new to Python, check out the Python tutorial or the Real Python getting started track first.
Coord2Region bridges the gap between 3D brain coordinates and scientific insight. It unifies anatomical mapping, meta-analytic literature search, and generative AI into a streamlined workflow.
Looking for technical details?
This page focuses on usage concepts and tutorials.
API Reference: Visit the API Reference menu for precise class and function specifications.
Development: See the Development menu for contribution guidelines.
Support: Check Get Help if you are running into issues.
Documentation pillars#
The documentation is organized into three sections to guide your usage:
User Guide – Step-by-step lessons on how to use Coord2Region. This includes the Tutorials, Examples Gallery, and detailed breakdowns of supported Supported Atlases and AI Provider Configuration.
Operational Interfaces – Instructions for the specific tools you use to interact with the package. Covers the CLI Tools and Web Interface, plus the core Concepts & Workflow logic.
Project Metadata – Contextual information about the software itself. Read about our Design & Implementation, how to provide How to Cite in your papers, the project Changelog, and the people involved in Contributors.