Core BEAT components¶
This package provides the core components of BEAT ecosystem. These core components are the building blocks of BEAT experiments that are used by all the other BEAT packages.
- Introduction
- Backend API
- Local Development
- API
- algorithm
load_algorithm_prototype()AlgorithmAlgorithm.nameAlgorithm.descriptionAlgorithm.documentationAlgorithm.storageAlgorithm.dataformatsAlgorithm.librariesAlgorithm.usesAlgorithm.parametersAlgorithm.splittableAlgorithm.input_mapAlgorithm.output_mapAlgorithm.resultsAlgorithm.groupsAlgorithm.errorsAlgorithm.dataAlgorithm.codeAlgorithm.dataformat_klass
- baseformat
- data
- data_loaders
- database
get_first_procotol_template()Database- dataformat
DataFormat- dock
HostContainerContainer.set_name()Container.set_workdir()Container.set_entrypoint()Container.add_volume()Container.add_tmpfs()Container.add_port()Container.add_environment_variable()Container.reset_ports()Container.nameContainer.workdirContainer.entrypointContainer.volumesContainer.temporary_filesystemsContainer.portsContainer.environment_variablesContainer.networkContainer.userContainer.command_line
- drawing
text_color()lighten_color()create_port_table()create_layout_ports_table()make_label()make_layout_label()- environment
enumerate_packages()- base
BaseExecutorBaseExecutor.cacheBaseExecutor.errorsBaseExecutor.dataBaseExecutor.algorithmBaseExecutor.databasesBaseExecutor.viewsBaseExecutor.input_listBaseExecutor.output_listBaseExecutor.data_sourcesBaseExecutor.data_sinksBaseExecutor.process()BaseExecutor.validBaseExecutor.analysisBaseExecutor.outputs_existBaseExecutor.io_statisticsBaseExecutor.write()BaseExecutor.dump_runner_configuration()BaseExecutor.dump_databases_provider_configuration()
- docker
DockerExecutorDockerExecutor.cacheDockerExecutor.errorsDockerExecutor.dataDockerExecutor.algorithmDockerExecutor.databasesDockerExecutor.viewsDockerExecutor.input_listDockerExecutor.output_listDockerExecutor.data_sourcesDockerExecutor.data_sinksDockerExecutor.CONTAINER_PREFIX_PATHDockerExecutor.CONTAINER_CACHE_PATHDockerExecutor.process()
- local
LocalExecutor- remote
RemoteExecutor- subprocess
SubprocessExecutorSubprocessExecutor.cacheSubprocessExecutor.errorsSubprocessExecutor.dataSubprocessExecutor.algorithmSubprocessExecutor.databasesSubprocessExecutor.viewsSubprocessExecutor.input_listSubprocessExecutor.output_listSubprocessExecutor.data_sourcesSubprocessExecutor.data_sinksSubprocessExecutor.process()
- experiment
StorageExperimentExperiment.storageExperiment.toolchainExperiment.databasesExperiment.algorithmsExperiment.datasetsExperiment.blocksExperiment.analyzersExperiment.errorsExperiment.dataExperiment.nameExperiment.labelExperiment.schema_versionExperiment.validExperiment.setup()Experiment.dot_diagram()Experiment.descriptionExperiment.documentationExperiment.hash()Experiment.json_dumps()Experiment.write()Experiment.export()
- hash
hashBlockOutput()hashAnalyzer()hashJSONStr()- inputs
- library
Library- loader
- outputs
- plotter
StorageRunnerPlotterPlotter.storagePlotter.dataformatPlotter.librariesPlotter.errorsPlotter.dataPlotter.codePlotter.schema_versionPlotter.namePlotter.languagePlotter.clean_parameter()Plotter.validPlotter.api_versionPlotter.uses_dict()Plotter.runner()Plotter.descriptionPlotter.json_dumps()Plotter.documentationPlotter.usesPlotter.parametersPlotter.hash()Plotter.write()
- stats
Statisticscpu_statistics()memory_statistics()- toolchain
StorageToolchainToolchain.storageToolchain.errorsToolchain.dataToolchain.schema_versionToolchain.nameToolchain.datasetsToolchain.blocksToolchain.loopsToolchain.analyzersToolchain.algorithm_item()Toolchain.connectionsToolchain.dependencies()Toolchain.execution_order()Toolchain.dot_diagram()Toolchain.validToolchain.descriptionToolchain.documentationToolchain.hash()Toolchain.json_dumps()Toolchain.write()
- utils
temporary_directory()uniq()send_multipart()find_free_port()find_free_port_in_range()id_generator()setup_logging()build_env_name()- worker
WorkerControllerWorkerController.READYWorkerController.EXITWorkerController.RECEIVEDWorkerController.DONEWorkerController.JOB_ERRORWorkerController.ERRORWorkerController.CANCELLEDWorkerController.EXECUTEWorkerController.CANCELWorkerController.ACKWorkerController.SCHEDULER_SHUTDOWNWorkerController.CallbacksWorkerController.destroy()WorkerController.execute()WorkerController.cancel()WorkerController.ack()WorkerController.process()
- ZMQ Architecture for task handling