Skip to content

CAVE: Connectome Annotation Versioning Engine

CAVE is a computational infrastructure for immediate and reproducible connectome analysis in up-to petascale datasets (~ $1mm^3$) while proofreading and annotating is ongoing. CAVE consists of a number of services and database management systems that are listed below. It was initially developed as a collaboration between the electron microscopy group at the Allen Institute for Brain Science and Sebastian Seung's lab at Princeton University. It is most fully described in a pre-print available here, though aspects of the PyChunkedGraph service were described also in earlier works (Dorkenwald et al. 2022a and Dorkenwald et al. 2022b). It is use by several large scale published electron microscopy efforts, including the MICrONS project, flywire, fanc, and h01, and several unpublished datasets.

Micro-Services

Info

A service for storing basic metadata about data, presently datastack, aligned_volume, permission_group and table_mapping. Repository

MiddleAuth: Authentication and authorization

A service for controlling authorization on top of authentication provided by Google OAuth. Repository

We deploy a second version of auth as "sticky" auth which has stick_sessions turned on. This is useful for certain operations that require sticky sessions, such as the flask-admin interface, whereas the other pods for auth do not require it and can distribute traffic more easily. There are no code base changes, only deployment changes.

Schema

A service for storing/serving presently supported annotation schemas. Note this is also a library that is utilized by AnnotationEngine and MaterializationEngine to generate database schemas. Repository

Jsonstateserver

A service for posting and retrieving json states. Intended to provide support for neuroglancer link shortening. Backed by Google Datastore (future version to place json in bucket storage). Repository

AnnotationEngine

A service for creating, reading and updating annotations on aligned volumes, independent of segmentation. Backed by postgreSQL and postGIS. Repository

MaterializationEngine

A service to keep a set of annotations up to date with a segmentation. Shared codebase also contains an API to query these annotations, and a worker to process these annotations. Backed by postgreSQL and postGIS, workflow powered by celery with a redis broker. Repository

Pychunkedgraph (PCG)

A service to dynamically proofread and track a supervoxel graph of a segmentation. Stores graph in a dynamic oct-tree backed by Google BigTable. Abbreviation PCG. Transmits activity via google pub-sub, presently consumed by Meshing and L2cache. Repository

Meshing

A service to track, serve and regenerate meshes from a dynamic segmentation (shared codebase with the PCG). Has a worker component as well, driven by google pubsub. Repository

L2Cache

A service to track, serve and regenerate summary statistics of “level 2” fragments of segmentation in the PCG. Has a worker component for calculating statistics,driven by google pub-sub. Repository

SkeletonService

A service to generate, cache, and serve skeletons. A variety of return formats are supported. Both a REST and CAVEclient UI or provided, in addition to an asynchronous message-based UI. Repository

Guidebook

A flask app service for creating neuroglancer links with annotation points to guide proofreaders to tips and branches. Guidebook utilizes PCG awfare skeletonization procedures via pcg_skel (see below). Repository

Dash

A flask app for serving dash apps that are protected by auth. Currently only serving dash-connectivity-viewer apps, provides interactive analysis UI of connectivity and cell types, along with dynamic neuroglancer link generation. Repository, Repository

ProofreadingProgress

An app designed for FlyWire to track proofreading progress. Repository

Proofreading Management

TBD. Repository (not public and not generalized past flywire)

Proxy Map

This is a deprecated service for redirecting traffic to a google bucket which is not publicly readable. Requests are rerouted to a configurable set of google buckets, with an authorization header that is attached by the server to allow the user to get access to the bucket. The resulting data is simply forwarded back to the user. Connections to these endpoints are protected by the authorization service and so access can be limited in this way. Allows neuroglancer communication. Repository (not public repo)

Libraries

DynamicAnnotationDB

Interface library for AnnotationEngine and MaterializationEngine to interface with SQLalchemy based dynamic databases. Repository

nglui

Library for automating creation of neuroglancer links from annotations as dataframes, wrapper over neuroglancer python. Repository

Access Tools

CaveClient

Python library for accessing various microservice endpoints. Repository, Documentation

MeshParty

Python library that wraps around cloudvolume to provide analysis and visualization functionality on top of meshes and skeleton. Repository, Documentation

Pcg_skel

Library for running skeletonization that integrates the chunkedgraph level2 graph, and the l2cache. Repository, Documentation

CAVE-adjacent Tools

These tools integrate with CAVE and are useful for CAVE users. They are developed and maintained by members of the community and not the CAVE team.

CloudVolume

Python library for accessing images, segmentation, meshes and skeletons from precomputed and CAVE (i.e. graphene protocol) sources. Repository, Documentation

Navis

Python library wrapped around many other libraries that gives analysis tools for analyzing neurons. Integrates with cloud-volume and caveclient. Focused mostly on fly neurons, but provides general blender integration for example. Repository, Documentation

Deployment

CAVE uses kubernetes for deployment. We developed a bash script based system of templates and config files to deploy CAVE. Repository, Instructions

Popular repositories Loading

  1. MeshParty MeshParty Public

    Python 35 16

  2. CAVEclient CAVEclient Public

    This is the python client for accessing REST APIs within the Connectome Annotation Versioning Engine.

    Python 25 11

  3. PyChunkedGraph PyChunkedGraph Public

    Data backend for fast proofreading of cell segmentations in connectomics datasets

    Python 23 10

  4. nglui nglui Public

    Python 10 4

  5. ImageryClient ImageryClient Public

    Publication-ready visualization of overlays of imagery and segmentation from cloudvolume data

    Python 9 2

  6. pcg_skel pcg_skel Public

    Robust skeletonization of PyChunkedGraph-backed objects

    Python 7 3

Repositories

Showing 10 of 32 repositories
  • AnnotationEngine Public

    A flask app rest interface for adding annotations to a cloud volume segmentation

    CAVEconnectome/AnnotationEngine’s past year of commit activity
    Python 2 MIT 0 8 7 Updated Nov 27, 2024
  • terraform-google-cave Public

    A repository to store terraform modules for setting up infrastructure as code for CAVE in google cloud

    CAVEconnectome/terraform-google-cave’s past year of commit activity
    HCL 0 MIT 0 0 0 Updated Nov 27, 2024
  • CAVEclient Public

    This is the python client for accessing REST APIs within the Connectome Annotation Versioning Engine.

    CAVEconnectome/CAVEclient’s past year of commit activity
    Python 25 MIT 11 26 6 Updated Nov 26, 2024
  • SkeletonService Public

    Skeleton querying and retrieval service

    CAVEconnectome/SkeletonService’s past year of commit activity
    Python 0 MIT 0 0 0 Updated Nov 25, 2024
  • nglui Public
    CAVEconnectome/nglui’s past year of commit activity
    Python 10 MIT 4 5 1 Updated Nov 24, 2024
  • CAVEconnectome/MaterializationEngine’s past year of commit activity
    Python 0 MIT 2 10 8 Updated Nov 23, 2024
  • PyChunkedGraph Public

    Data backend for fast proofreading of cell segmentations in connectomics datasets

    CAVEconnectome/PyChunkedGraph’s past year of commit activity
    Python 23 MPL-2.0 10 17 10 Updated Nov 21, 2024
  • CAVEconnectome/MeshParty’s past year of commit activity
    Python 35 Apache-2.0 16 16 5 Updated Nov 18, 2024
  • CAVEconnectome/CAVEdeployment’s past year of commit activity
    Shell 2 MIT 6 11 1 Updated Nov 11, 2024
  • cave-helm-charts Public

    repository to store helm charts for deploying CAVE services to kubernetes

    CAVEconnectome/cave-helm-charts’s past year of commit activity
    Smarty 0 MIT 0 0 0 Updated Nov 6, 2024

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…