API

This section includes information for using the Python API of beat.core.

algorithm

Validation for algorithms

Forward importing from beat.backend.python.algorithm beat.backend.python.algorithm.Storage beat.backend.python.algorithm.Runner

baseformat

Froward imports from beat.backend.python.baseformat

data

Forward importing from beat.backend.python.data: beat.backend.python.data.mixDataIndices() beat.backend.python.data.getAllFilenames() beat.backend.python.data.DataSource beat.backend.python.data.CachedDataSource beat.backend.python.data.DatabaseOutputDataSource beat.backend.python.data.RemoteDataSource beat.backend.python.data.DataSink beat.backend.python.data.CachedDataSink beat.backend.python.data.StdoutDataSink beat.backend.python.data.load_data_index() beat.backend.python.data.load_data_index_db() beat.backend.python.data.foundSplitRanges()

data_loaders

Forward importing from beat.backend.python.data_loaders beat.backend.python.data_loaders.DataLoaderList beat.backend.python.data_loaders.DataLoader beat.backend.python.data_loaders.DataView

database

Validation of databases

Forward importing from beat.backend.python.database: beat.backend.python.database.Storage

dataformat

Validation and parsing for dataformats

Forward importing from beat.backend.python.dataformat: beat.backend.python.dataformat.Storage

dock

Docker helper classes

drawing

Utilities for drawing toolchains and experiments

environment

Helper functions related to environment management

base

Execution utilities

docker

Execution utilities

local

Execution utilities

remote

Execution utilities

subprocess

Execution utilities

experiment

Validation for experiments

hash

Various functions for hashing platform contributions and others

Also forward importing from beat.backend.python.hash

inputs

Forward imported from beat.backend.python.inputs:

beat.backend.python.inputs.InputList beat.backend.python.inputs.Input beat.backend.python.inputs.InputGroup

library

Validation for libraries

Forward imported from beat.backend.python.library: beat.backend.python.library.Storage

loader

Forward imports from beat.backend.python.loader

outputs

Forward imported from beat.backend.python.outputs: beat.backend.python.outputs.SynchronizationListener beat.backend.python.outputs.Output beat.backend.python.outputs.OutputList

plotter

Validation for plotters

stats

A class that can read, validate and update statistical information

Forward impored from beat.backend.python.stats: beat.backend.python.stats.io_statistics() beat.backend.python.stats.update()

toolchain

Validation for toolchains

utils

Helper methods

Forward imports from beat.backend.python.utils

worker

Worker implementation