Skip to content

Commit

Permalink
doc: design diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
c-dilks committed Nov 17, 2023
1 parent 33ae07d commit 82e40cd
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions doc/design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Design

## Class Diagram

### Legend

```mermaid
flowchart TB
classDef cls fill:88ff88,color:black
subgraph Inheritance
b[Base Class]:::cls
d[Derived Class]:::cls
end
d --|> b
subgraph Ownership
c[Class]:::cls
o[Object owned by Class]:::cls
end
c --> o
```

### Iguana Design

```mermaid
flowchart TB
classDef cls fill:88ff88,color:black
classDef algo fill:ff8888,color:black
subgraph iguana
Iguana:::cls
end
subgraph services
Algorithm:::cls
AlgorithmConfig:::cls
Logger:::cls
end
subgraph algorithms
FiducialCuts:::algo
FiducialCutsConfig:::algo
MomentumCorrection:::algo
MomentumCorrectionConfig:::algo
end
Iguana --> Logger
Iguana --> Algorithm
Algorithm --> Logger
Algorithm --> AlgorithmConfig
FiducialCuts --|> Algorithm
FiducialCutsConfig --|> AlgorithmConfig
MomentumCorrection --|> Algorithm
MomentumCorrectionConfig --|> AlgorithmConfig
```

0 comments on commit 82e40cd

Please sign in to comment.