Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow/UML diagram(s) #76

Open
ryancoe opened this issue Mar 26, 2020 · 7 comments
Open

Workflow/UML diagram(s) #76

ryancoe opened this issue Mar 26, 2020 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@ryancoe
Copy link
Member

ryancoe commented Mar 26, 2020

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

@ryancoe ryancoe added the documentation Improvements or additions to documentation label Mar 26, 2020
@ssolson
Copy link
Collaborator

ssolson commented Mar 26, 2020

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

@ryancoe
Copy link
Member Author

ryancoe commented Mar 26, 2020

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
Copy link
Collaborator

ssolson commented Mar 26, 2020

Also, OmniGraffle is strictly Mac and iOS.

@ryancoe
Copy link
Member Author

ryancoe commented Mar 26, 2020

Also, OmniGraffle is strictly Mac and iOS.

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

@ryancoe
Copy link
Member Author

ryancoe commented Mar 26, 2020

c7f4515 adds diagram from above to ghpages

@H0R5E H0R5E added this to the 0.2 milestone Apr 17, 2020
@ryancoe
Copy link
Member Author

ryancoe commented Sep 8, 2020

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

@ssolson
Copy link
Collaborator

ssolson commented Sep 8, 2020

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.

@H0R5E H0R5E removed this from the 0.2 milestone Sep 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants