Welcome to the cbcflow documentation!

CBCFlow allows convenient and machine readable storage, communication, and retrieval of important metadata for CBC analyses of events. This project consists of three parts:

1. Metadata for superevents, stored in a standardized format

2. A Python API for interacting with that metadata

3. Integrated visualization tools

Important Links

When using cbcflow, there are a lot of different links which may be important. For convenience, we note some here:

1. The current (O4a) library

   1. The issues page for that library, to track developments

   2. The cluster copy of this library (read only) is at CIT:/home/cbc/cbcflow/O4a/cbc-workflow-o4a

2. The GWOSC visualization page for the library

3. The cbcflow development repository

   1. The mattermost help channel

This Documentation

These pages are meant to provide tutorials and examples for interacting with and developing cbcflow, as well as documenting the API. If you find anything unclear or missing, please request improvements to the documentation here

Getting Started

• Configuration
• Setting Up A Library From a Remote
• Basics of Metadata
• How To Read The Schema
• Command Line Interface - Basics
• Command Line: Updating Metadata

Using CBCFlow's Python API

• Building Blocks: Metadata and Libraries
• Updating Metadata with Python
• The LocalLibraryDatabase

Integrated Projects

• Asimov Integration
• GWOSC Internal Portal

Expert Usage

• Installation
• Making Your Own Library
• Using the GraceDB Monitor
• Using Library Indices
• Index Labelling
• Merging JSON Files with cbcflow

Schema Information:

• Schema Breakdown
• Adding to the schema

API

cbcflow.core	Core functionality of cbcflow, including tools for managing metadata and libraries
cbcflow.inputs	The module for data which goes into the library in a standard way, including gracedb, official pe, and asimov
cbcflow.outputs	The module for data which leaves cbcflow in a standardized way
cbcflow.client	The module for client scripts in cbcflow