BSB HDF5 storage engine

bsb-hdf5 is the default storage engine for the BSB. It persists a network (placement, connectivity, morphologies, files) to a single HDF5 file and mediates concurrent rank access via an MPILock.

This site contains the narrative dev docs and the auto-generated API reference. For end-user configuration of the storage block, see the main BSB documentation.

Architecture

• Architecture
  • The pieces
  • File layout
  • The MPI lock
  • The handle wrapper
  • The rank-collective decorators
  • Telemetry
• Handles
  • The handles_handles decorator
  • Automatic reuse, and the explicit override
  • Batching with read_scope and write_scope
  • PromotedHandleWarning
  • UnusedWriteScopeWarning
  • The cost of not batching
• Chunked storage
  • The chunk size attribute
  • Chunks at rest
  • The ChunkLoader mixin
  • The chunk-id ordering matters
  • Stats and the global chunks attribute
• Resources
  • PlacementSet
  • ConnectivitySet
  • MorphologyRepository
  • FileStore
  • Batching reads and writes
• Telemetry
  • The local tracer
  • Why the broadcast had to go
  • Adding new spans
  • What gets emitted automatically

Reference

• bsb_hdf5 package
  • Submodules
  • Module contents
• Index
• Module Index