Skip to content

Social-Evolution-and-Behavior/crantpy

Repository files navigation

CRANTpy

Python Access to the Clonal Raider ANT Brain Connectome

Documentation Python 3.10+ License: GPL v3

A comprehensive Python interface for exploring the complete neural connectome of the clonal raider ant (Ooceraea biroi).

📖 Documentation🚀 Quick Start💡 Examples


✨ Features

  • 🔍 Intelligent Querying - Filter neurons by anatomy, cell type, or custom criteria
  • 🌐 CAVE Integration - Direct access to the Connectome Annotation Versioning Engine
  • 📊 Rich Metadata - Comprehensive neuron annotations and properties
  • 🧮 Morphological Tools - Analyze neuron meshes, skeletons, and connectivity
  • ⚡ High Performance - Optimized caching and batch processing

📦 Installation

pip install crantpy

Requirements: Python 3.10+

🚀 Quick Example

import crantpy as cp

# One-time setup
cp.generate_cave_token(save=True)

# Query and analyze neurons
neurons = cp.NeuronCriteria(cell_class='kenyon_cell')
skeleton = cp.get_skeletons(neurons.get_roots()[0])

print(f"Cable length: {skeleton.cable_length:.0f} nm")
skeleton.plot3d()  # Interactive 3D visualization

📚 Learn More

Visit our comprehensive documentation for:

🤝 Contributing

We welcome contributions! See our contribution guidelines or visit GitHub Discussions.

📝 Citation

@software{crantpy,
  title={CRANTpy: Python Access to Clonal Raider ANT Brain Datasets},
  author={CRANTb Community},
  url={https://github.com/Social-Evolution-and-Behavior/crantpy},
  year={2025}
}

Important: CRANTpy is built upon fafbseg-py by Dr. Philipp Schlegel from the FlyWire Drosophila Connectome Project. Please try to also cite the FlyWire project papers when using this tool.

🙏 Acknowledgements

We gratefully acknowledge Dr. Philipp Schlegel (MRC Laboratory of Molecular Biology, Cambridge) for developing fafbseg-py, upon which CRANTpy is based. See our full acknowledgements for complete contributor information.

📄 License

GNU General Public License v3.0 - see LICENSE for details.


Made with ❤️ by the CRANTb Community

About

Python Access to Clonal Raider ANT (CRANT) Datasets

Topics

Resources

License

Stars

Watchers

Forks

Contributors 5