How ssi-dk/bifrostlib works
Main Components
a) Core Library Components:
• Data Handling Module (datahandling.py)
• Database Interface (database_interface.py)
• Common Utilities (common.py)
• Schema Definitions (schemas/bifrost.jsonc)
b) External Interfaces:
• File System Interface (for reading directories of reads)
• Database Connection Layer
• PyPI Distribution System
c) Workflow Components:
• Sample Processing Pipeline
• Run Management System
• Component Execution Engine
Top Layer: Client Applications/Users
Middle Layer: Core Library Components
Bottom Layer: Storage & External Systems
Specific Elements
a) Data Flow Components:
• Read Directory
• Metadata.tsv
• Configuration Files
• Sample Object Creation
• Run Object Management
• Component Execution
• Sample Components
• Results Storage
• Execution Reports
b) Key Relationships:
Specific Implementation Details
[Input Files] → [Sample Creation] → [Run Object] → [Component Execution] → [Results]
• ↕ ↕ ↕
• [Database Interface] ← [Common Utilities] → [Schema Validation]
Technical Notes
• Use standardized UML or C4 model notation
• Version/release management flow
• Test integration points
• Configuration points