How hivdb/sierra works
Main Components Identification
a) Core Components:
• sierra-core: Main business logic
• sierra-graphql: GraphQL API layer
• sierra-tests: Testing framework
• hivfacts: HIV-specific data and rules
• asi_interpreter: Algorithm interpretation component
b) Web Layer:
• GraphQL Services (HIV1 and HIV2)
• REST endpoints
• CORS Filter
• Error handling
c) External Dependencies:
• PostAlign Alignment Program
• Docker container runtime
• Database (for development)
Architecture Layers
Client Layer
API Layer (GraphQL/REST)
Service Layer
Core Business Logic
Data Access Layer
Specific Components Detail
a) Web Components:
┌─────────────────────┐
• GraphQL API │
• HIV1 Endpoint │
• HIV2 Endpoint │
• ┘
b) Core Processing:
┌─────────────────────┐
• Sierra Core │
• Sequence Analysis │
• Drug Resistance │
• Mutation Analysis │
• ┘
c) Supporting Services:
┌─────────────────────┐
• External Services │
• PostAlign │
• ASI Interpreter │
• ┘
Infrastructure Components
Deployment-related components:
┌─────────────────────┐
• Docker Container │
• Tomcat Server │
• Java Runtime │
• ┘
Key Interactions
Following flows:
• Sequence submission flow
• Alignment processing
• Resistance interpretation
• Result delivery
Additional Elements
Include:
• Version information
• System requirements
• External dependency versions
• API endpoints
Notes
Annotations for:
• Required environment variables
• Configuration requirements
• Security considerations
• Performance considerations
• Hierarchical layouts
• Export to common formats
• Version control friendly format
Remember to maintain a balance between detail and clarity, focusing on the key architectural decisions while avoiding overwhelming detail that might obscure the main system structure.
• System boundaries
• Component interactions
• Data flow
• Deployment architecture
• Integration points
• Security boundaries