DrylandEcology / STEPWAT2

folder
4 stars 5 forks source link

Restructure STEPWAT2 #478

Open chaukap opened 4 years ago

chaukap commented 4 years ago

The structure of the STEPWAT2 repository could be streamlined very easily to make it easier to understand and use. I spent some time thinking about what the new structure could look like and this is my suggestion:

The main directory: dev
documentation
outputs
inputs
makefile
README.md
doxyfile
dev: sw_src
test
tools
obj
sqlite-amalgamation
All of the .c and .h files
Inputs: Grid_Inputs
Single-plot_inputs
files.in
sxwdebug.in
Outputs: sw_output
logfile.log

There are obviously some small details to still work out, but I think this general structure would be much easier to understand.

kpalmqui commented 4 years ago

@dschlaep it would be great to get your thoughts on this. We have three goals here:

1) make the file/folder structure clearer to users and developers 2) remove the contingency that you need to be a certain folder to run non-gridded vs. gridded mode 3) remove unnecessary folders that once duplicated in rSFSTEP2 take up unnecessary space

perhaps something similiar to be done with SOILWAT2?

dschlaep commented 4 years ago

A few quick thoughts:

Maybe a meeting would be easier?

chaukap commented 4 years ago

@dschlaep I could do a meeting sometime next week; maybe Monday or Tuesday? @kpalmqui does a time next week work for you?

chaukap commented 4 years ago

To sum up the meeting @kpalmqui, @dschlaep and I had, we decided that restructuring both STEPWAT2 and SOILWAT2 would be a good idea. In general the layout I describe above will work for STEPWAT2.

However, we decided that before we restructure the files we should decouple the STEPWAT2 makefile from any specific SOILWAT2 structure. This means the STEPWAT2 makefile should call the SOILWAT2 makefile then use the resultant library file to build STEPWAT as opposed to building STEPWAT2 using SOILWAT2 files directly. I will open a separate issue for this and depending on how quickly we can merge in the other development branches I will implement the change.

chaukap commented 4 years ago

Issue #483 summarizes the changes that must occur to decouple the STEPWAT2 makefile.