Get Help#

Whether you have encountered a bug, have a question about a specific feature, or need to report a safety concern, you are in the right place.

Troubleshooting & Questions#

If Coord2Region isn’t behaving as expected, please follow these steps before opening a new ticket:

  1. Check the Documentation Most questions are answered in the guides:

    • tutorials – Step-by-step recipes for standard workflows.

    • CLI Tools – Syntax reference for command-line arguments.

    • API Reference – Details on Python classes and parameters.

  2. Search Existing Issues Someone else may have already solved your problem. Search open and closed threads on our GitHub Issues.

  3. Report a Bug If you found a new issue, please open a bug report. To help us fix it quickly, include:

    • The command or script you ran.

    • The full traceback/error message.

    • Your OS (Mac/Linux/Windows) and Python version.

    • A snippet of your coord2region.yaml (please remove your API keys first!).

Community Standards#

We are committed to providing a welcoming and harassment-free environment for everyone.

  • Code of Conduct: All interactions—on GitHub, in chat, or at conferences—are governed by our Code of Conduct.

  • Security: If you discover a potential security vulnerability (e.g., regarding API key handling), please follow the instructions in SECURITY.md on GitHub rather than posting a public issue.

Citing Coord2Region#

We appreciate citations! They help us justify funding and maintenance efforts for the CoCo Lab.

Please refer to the dedicated :doc:`documentation/citation` page for:

  • The official BibTeX entry.

  • The Zenodo DOI.

  • Guidelines on how to credit the specific Atlases and AI Models you used.