Home

CAVE is short for Connectome Annotation Versioning Engine. CAVE is a set of microservices that provide a framework for storing and versioning connectomics data and large sets of dynamic annotations, metadata, and segmentations. This repository supplies client-side code to easily interact with the microservices in CAVE.

Documentation Layout

To learn how to install caveclient, visit Installation.

To see hands-on examples of using caveclient in a notebook, visit the Tutorials.

To see API reference documentation for interacting with a caveclient.CAVEclient object (most common), visit the Client API.

To see API reference documentation for interacting with the individual services, visit the Extended API.

To see a glossary of terms used in the documentation, visit the Glossary (work in progress).

For information about how to contribute to the documentation or the package, visit the Contributing page. Feedback on the documentation is welcome! Please open an issue or use the "Edit this page" button at the top right of any page to suggest changes.

To read a full description of the Connectome Annotation Versioning Engine, including a description of the various services please read this paper.