9 generate functional flow diagrams #10
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #9
Adding new docs folder with flow diagram sub directory
Markdown flow diagrams created for a selection of ONEflux submodule components starting with a summary of the ustar_cp methodology itself.
Initial workflow analysis done for main ustar_cp workflows using chat GPT. If we think these are useful, I think we can automate the generation of this type of summary over the whole codebase using a code based api.
Interested in your feedback. I find this type of summary useful for being able to see more clearly how the code is structured and as a prompt to think about whether or not we need to rearchitect ustar_cp.
These summaries do not include commented out methods in the matlab files.