chore(architecture diagrams): add C4 diagrams#8
Conversation
* add a C4 system context diagram
|
@Bai-Li-NOAA gemini helped me figure out how to get rid of the titles in the subgraph, it is expecting a string not ""\n so if you replace the string with "" but add a space before the return then it will render without a subgraph title. |
kellijohnson-NOAA
left a comment
There was a problem hiding this comment.
I tried to get the link between DSEM and SA but like your trials and tribulations I was unable to make it happen without changing the entire structure of the diagram. But, I do not think that we need all three external systems in the separate box, especially EWE models with DSEM and SA. I think that the legend helps define what they are and they do not need to be grouped together.
Also, I am unsure why some lines are dashed and some are solid.
| @@ -0,0 +1,70 @@ | |||
| # System context diagram | |||
|
|
|||
| This diagram presents the ecosystem simulation toolkit at the center, surrounded by its users and the external systems | |||
There was a problem hiding this comment.
| This diagram presents the ecosystem simulation toolkit at the center, surrounded by its users and the external systems | |
| This diagram presents the ecosystem-simulation toolkit at the center, surrounded by its users and the external systems |
| U1[<b>User 1</b><br/><br/>-<i>Person</i>-<br/><br/>Ecosystem Modeler]:::lightblue | ||
| U2[<b>User 2</b><br/><br/>-<i>Person</i>-<br/><br/>General Data User]:::lightblue | ||
| U3[<b>User 3</b><br/><br/>-<i>Person</i>-<br/><br/>Stock Assessment Modeler]:::lightblue |
There was a problem hiding this comment.
I would prefer to take out the -<i>Person<\i> from each of these lines because it is clear from the legend that it is a "person" and it would allow for more room for the diagram. Same for -<i>External System</i>- on lines 43--35.
| %% Define external systems | ||
| subgraph "" | ||
| direction TB | ||
| EM[<b>Ecosystem Models</b><br/><br/> -<i>External System</i>-<br/><br/> Simulate ecosystem dynamics and produce raw outputs]:::lightpurple |
There was a problem hiding this comment.
Can we list EWE and Atlantis here instead of "External System"?
| subgraph "" | ||
| direction TB | ||
| EM[<b>Ecosystem Models</b><br/><br/> -<i>External System</i>-<br/><br/> Simulate ecosystem dynamics and produce raw outputs]:::lightpurple | ||
| DSEM[<b>Dynamic Structural Equation Models</b><br/><br/> -<i>External System</i>-<br/><br/> Fit dynamic structural equation models]:::lightpurple |
There was a problem hiding this comment.
Does mermaid have the ability to provide a hyper link to the DSEM repository with the text here?
| direction TB | ||
| EM[<b>Ecosystem Models</b><br/><br/> -<i>External System</i>-<br/><br/> Simulate ecosystem dynamics and produce raw outputs]:::lightpurple | ||
| DSEM[<b>Dynamic Structural Equation Models</b><br/><br/> -<i>External System</i>-<br/><br/> Fit dynamic structural equation models]:::lightpurple | ||
| SA[<b>Stock Assessment Models</b><br/><br/> -<i>External System</i>-<br/><br/> Analyze fisheries and environmental impacts on fish stocks]:::lightpurple |
There was a problem hiding this comment.
Can we list example models here like FIMS with a hyperlink instead of "External System"?
| %% Define ecosystem simulation toolkit | ||
| subgraph "" | ||
| direction LR | ||
| EcosystemData[<b>ecosystemdata</b><br/><br/> -<i>R package</i>-<br/><br/> -Standardizes model output<br/>-Provides functions to connect with external tools to perform time series analysis]:::lightgreen |
There was a problem hiding this comment.
I do not quite understand what you are trying to imply with "Provides functions to connect with external tools to perform time series analysis"
| subgraph "" | ||
| direction LR | ||
| EcosystemData[<b>ecosystemdata</b><br/><br/> -<i>R package</i>-<br/><br/> -Standardizes model output<br/>-Provides functions to connect with external tools to perform time series analysis]:::lightgreen | ||
| EcosystemOM[<b>ecosystemom</b><br/><br/> -<i>R package</i>-<br/><br/> Samples observations from ecosystemdata for stock assessment testing]:::lightgreen |
There was a problem hiding this comment.
| EcosystemOM[<b>ecosystemom</b><br/><br/> -<i>R package</i>-<br/><br/> Samples observations from ecosystemdata for stock assessment testing]:::lightgreen | |
| EcosystemOM[<b>ecosystemom</b><br/><br/> -<i>R package</i>-<br/><br/> Samples observations from ecosystemdata to fit to stock assessments]:::lightgreen |
What is the feature?
How have you implemented the solution?
architecture_diagrams/system_context_diagram.md/architecture_diagramsfolder to.RbuildignoreDoes the PR impact any other area of the project, maybe another repo?