search

SNL-WaterPower / WecOptTool-MATLAB

WEC Design Optimization Toolbox
GNU General Public License v3.0
12 stars 9 forks source link

Workflow/UML diagram(s) #76

Open ryancoe opened 4 years ago

ryancoe commented 4 years ago

I made diagram bellow for we use in a previous paper. This used to have filenames that went with the different blocks, but those are no longer relevant. I think new users would find something like this useful. I see two paths:

  1. Update this diagram to align with our new structure
  2. Do something different (e.g., UML)

We could do both 1 and 2, or either... any thoughts?

WecOptTool_algorithmDiagram

ssolson commented 4 years ago

I thought about adding this to the documentation. I think it would be very useful. Did you create this tikz?

ryancoe commented 4 years ago

I made this in OmniGraffle, tikz is a bit too hardcore for me. However, having some sort of graphic like this that has asci source would be preferable in terms of version control.

In the short term, I'll make some minor tweaks and add to the documentation. We should keep the issue open and try to refine and/or expand on this later.

ssolson commented 4 years ago

Also, OmniGraffle is strictly Mac and iOS.

ryancoe commented 4 years ago

Also, OmniGraffle is strictly Mac and iOS.

Sometime soon Windows will cease to exist, so maybe we just until then?

ryancoe commented 4 years ago

c7f4515 adds diagram from above to ghpages

ryancoe commented 4 years ago

@ssolson - wasn't this completed with #158?

ssolson commented 4 years ago

We were drawing some differences between a flow chart/ UML diagram. I would say feel free to close and we can reopen as a UML diagram becomes more of an active effort.