blue_cwl.registering¶

Registering utilities.

Functions

`register_cell_composition`(*, name, ...[, ...])	Register CellComposition.
`register_cell_composition_summary`(*, name, ...)	Create and register a cell composition summary.
`register_cell_composition_volume`(*, name, ...)	Create and register a cell composition summary.
`register_densities`(*, atlas_release, ...[, ...])	Register METypeDensity volumes.
`register_partial_circuit`(*, name, ...[, ...])	Register a partial circuit.

blue_cwl.registering.register_cell_composition(*, name: str, description: str, atlas_release: AtlasRelease, cell_composition_volume_file: str | PathLike[str], cell_composition_summary_file: str | PathLike[str], contribution: Contribution | None = None, base=None, org=None, proj=None, token=None)¶: Register CellComposition.

blue_cwl.registering.register_cell_composition_summary(*, name: str, description: str, distribution_file: str | PathLike[str], atlas_release: AtlasRelease, derivation_entity: Entity, contribution: Entity | None = None, base=None, org=None, proj=None, token=None) → CellCompositionSummary¶: Create and register a cell composition summary.

blue_cwl.registering.register_cell_composition_volume(*, name: str, description: str, distribution_file: str | PathLike[str], atlas_release: AtlasRelease, derivation_entity: Entity, contribution: Contribution | None = None, base=None, org=None, proj=None, token=None) → CellCompositionSummary¶: Create and register a cell composition summary.

blue_cwl.registering.register_densities(*, atlas_release: AtlasRelease, distribution_file: str | PathLike[str], output_file: str | PathLike[str] | None = None, contribution: Contribution | None = None, base: str | None = None, org: str | None = None, proj: str | None = None, token: str | None = None) → dict¶: Register METypeDensity volumes.

blue_cwl.registering.register_partial_circuit(*, name: str, brain_region_id: str, atlas_release: AtlasRelease, sonata_config_path: str | PathLike[str], description: str = '', species_id: str | None = None, contribution: Contribution | None = None, base: str | None = None, org: str | None = None, proj: str | None = None, token: str | None = None) → DetailedCircuit¶: Register a partial circuit.