Cambridge-ICCS / ONEFlux

Open Network-Enabled Flux processing pipeline
Other
0 stars 0 forks source link

9 generate functional flow diagrams #10

Open j-emberton opened 4 months ago

j-emberton commented 4 months ago

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.