Riverscapes / pyBRAT

pyBRAT - Beaver Restoration Assessment Tool (Python)
http://brat.riverscapes.xyz
GNU General Public License v3.0
10 stars 10 forks source link

Folder Structure of BRAT #197

Closed joewheaton closed 5 years ago

joewheaton commented 5 years ago

HI Braden, I should have looked at this earlier, but I have not. I'm going to suggest that we change the BRAT project folder structure to be more consistent with GCD folder structure and more intuitive.

Current Project

Right now, as best I can tell you just have an Inputs, a Temp folder and as many Output_n that autonumber. You also have a log file in root and a project.rs.xml riverscapes project file. brat_project

Your inputs:

brat_inputs This works. I imagine adding an 05_DataCapture events for the Survey123 BRAT_cIS runs as well as Dam Surveys and Dam Complex Surveys (all three of are of type point). So maybe something like:


What I dislike

I'm not sure about

I like how you use two digit, numeric prefixes to keep the sub-folders in order (e.g. 01 02) . However, this could get confusing to sum with things that are 'realizations'. I think its okay as long as 'realizations' (things there are more than one of) are kept as suffixes (i.e. after _00)

Intermediates

I see the logic in having all the intermediates in its own Output_0n realization folder: brat_intermediates

GCD

Here's an example of a GCD project: gcd_project And this is how that directory structure is accessed by the GCD Project Explorer: gcd_tree

You can see how there are a bunch of libraries under inputs (DEM Surveys, Reference Surfaces, Masks and Profile Routes), which are analogous to your 01_Vegetation, 02_Network, 03_Topography, 04_Anthropogenic. So those concepts port across nicely, and the idea of having as many different versions of inputs is also nice.

Note that in GCD we have Analyses instead of Outputs. Not sure if it matters. But then we have different types of analyses like CD for Change Detection, and IC for inter comparison. I do imagine we'll add new analyses to BRAT like:

We should think about where these should be housed.

Thoughts @wally-mac and @philipbaileynar?

joewheaton commented 5 years ago

@banderson1618 can you scope these changes above please? It is relevant to your XML recode as in principle we should have as close as alignment as possible in the nesting and folder structure between:

Also, let me know if anything does not make sense!

banderson1618 commented 5 years ago

Since the only major change that I'm seeing is putting the outputs in an Outputs folder, and changing one digit numbers to two digit numbers, I think this should be a pretty quick change. I'm still focusing on XML changes, since that seems more pressing to me, but if you want, @joewheaton, I can set that down and work on this.

joewheaton commented 5 years ago

@banderson1618 that makes sense to focus on XML. This will play into that and it is related... so as long as you charge ahead on XML with this in mind, I think we're good. Then pick this up when it makes sense next (& before we have analysts crank through all the Idaho and TNC runs).

Cheers, Joe