Map of code dependencies

[mpalmsten]

Several attendees of the workshop mentioned that the code dependencies within the cBathy Toolbox are not clear and suggested that a flow chart or map of the code would be really useful.

I suggest we build a graphical map of the code to help new users. This would be a great task for someone learning the code to put together to help others.

[chrisleaman]

I managed to get an automatic dependancy map generated using M2HTML and Graphviz. I'll look into a bit more scripting to turn it into something a bit more useful, maybe adding function descriptions, colors, adjusting layout etc. Will post more soon.

[SRHarrison]

Hey, that's exactly how it looks in my brain!

On Wed, Jun 13, 2018 at 3:11 PM, Chris Leaman notifications@github.com wrote:

I managed to get an automatic dependancy map generated using M2HTML https://www.artefact.tk/software/matlab/m2html/tutorial.php and Graphviz http://www.graphviz.org/. I'll look into a bit more scripting to turn it into something a bit more useful, maybe adding function descriptions, colors, adjusting layout etc. Will post more soon.

[image: graph] https://user-images.githubusercontent.com/7591552/41381171-71ffe762-6f2c-11e8-9d4e-71b796909cc1.png

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/Coastal-Imaging-Research-Network/cBathy-Toolbox/issues/48#issuecomment-397104240, or mute the thread https://github.com/notifications/unsubscribe-auth/AVa07ZEHXZ_o8f_zxOkK4cKPlxYn0xtlks5t8Y4XgaJpZM4Umv71 .

[mpalmsten]

Thanks Chris! Super cool that you could generate the map from a script.

[RobHolman]

This was pretty amusing and amazing that you could do this automatically. I can see recognizeable structure in there, but not yet in a useful way. Maybe I will spend a bit of time on it, hopefully not fully duplicating what you are doing.

YHS

Rob Holman SECNAV/CNO Chair in Oceanography

104 Ocean Admin Bldg. CEOAS-OSU Corvallis, Oregon, USA 97331-5503 ph: 1-541-737-2914 holman@coas.oregonstate.edu http://cil-www.coas.oregonstate.edu

On Jun 13, 2018, at 3:11 PM, Chris Leaman notifications@github.com wrote:

I managed to get an automatic dependancy map generated using M2HTML and Graphviz. I'll look into a bit more scripting to turn it into something a bit more useful, maybe adding function descriptions, colors, adjusting layout etc. Will post more soon.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

[RobHolman]

I’m hoping this shows up on the cBathy site. But attached is a draft powerpoint of logic flow for cBathy. It has two overview slides then slides for each analysis phase. We could make these into pdfs if they are useful. I could also make up slides that show the debug function calls.

YHS…Rob

Rob Holman SECNAV/CNO Chair in Oceanography

104 Ocean Admin Bldg. CEOAS-OSU Corvallis, Oregon, USA 97331-5503 ph: 1-541-737-2914 holman@coas.oregonstate.edu http://cil-www.coas.oregonstate.edu

On Jun 13, 2018, at 3:11 PM, Chris Leaman notifications@github.com wrote:

I managed to get an automatic dependancy map generated using M2HTML and Graphviz. I'll look into a bit more scripting to turn it into something a bit more useful, maybe adding function descriptions, colors, adjusting layout etc. Will post more soon.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

[chrisleaman]

Sorry @RobHolman, it doesn't look like the attachments are showing up. I think you need to visit the github issues page to upload the files.

[RobHolman]

cBathyLogicFlow.pptx How about now?

[mpalmsten]

From @SBFRF:

To help users understand what matlab packages would be required to run, this toolbox (and others) should identify packages and dependencies needed to run https://www.mathworks.com/help/matlab/matlab_prog/identify-dependencies.html

[mpalmsten]

Map of code dependencies for v2.0 is included in: Holman, R., and E. W. J. Bergsma (2021), Updates to and performance of the cBathy algorithm for estimating nearshore bathymetry from remote sensing imagery., Remote Sens., 13, 3996, doi:https://doi.org/10.3390/rs13193996.