Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-organize repository with more sub-folders #89

Closed
dschlaep opened this issue Nov 27, 2017 · 2 comments
Closed

Re-organize repository with more sub-folders #89

dschlaep opened this issue Nov 27, 2017 · 2 comments

Comments

@dschlaep
Copy link
Member

Currently, all code files, doxygen-file, bib-file, etc. are located at the top-level. I find that navigating is tedious. I suggest that we implement a more hierarchical structure. For instance.

SOILWAT2/
     |__ .travis.yml
     |__ appveyor.yml
     |__ bin/                   <-- folder where standalone binary/executable is created and 'testing'ed
          |__ SW_Main.c
          |__ testing/
     |__ doc/
          |__ html/
          |__ SOILWAT2.bib
     |__ Doxyfile
     |__ googletest/
     |__ makefile
     |__ Makevars
     |__ README.md
     |__ src/                   <-- all source files except the 'main' functions
     |__ test/
@dschlaep dschlaep added this to the Clean code milestone Nov 27, 2017
@dschlaep
Copy link
Member Author

dschlaep commented Dec 4, 2017

@CaitlinA What do you think about my suggestion to organize the code?

@CaitlinA
Copy link
Member

CaitlinA commented Dec 4, 2017

Given the addition of the new documentation and testing files and folders, I think this a great idea!

dschlaep added a commit that referenced this issue Jul 25, 2019
- addressing #89 (Re-organize repository with more sub-folders)
dschlaep added a commit that referenced this issue Jul 25, 2019
…eptions)

- fix #266 (comment)
- addressing #266

- new script `tools/run_doxygen.sh`
- new make targets: "doc" and "doc_clean"

- continuous integration: travis-ci will now use the new script which fails on warnings, but disregards exceptions that are documented in the new file `doc/doxygen_exceptions.txt`

- currently, there is one known exception, see #267

- moved `Doxyfile` to `doc/` (addressing #89)
dschlaep added a commit to DrylandEcology/STEPWAT2 that referenced this issue Jul 14, 2020
…LWAT2

- address #483
- contribute to DrylandEcology/SOILWAT2#89

--> the subfolder path of SOILWAT2 occurs now consistently on the STEPWAT2 side:
1) makefile variable "path_sw2"
2) in the include header directives (see previous commit)
--> if SOILWAT2 changes its file organization, then search/replace of "sw_src" with the new value can now be done

Other changes:
- since CC is hard-coded to gcc, I defined CXX to g++ so that compilation occurs only within compiler families (and not potentially across, e.g., in case CXX would be defined as clang++)
- helper targets to run STEPWAT2 executable in example folder, i.e., `bint_testing_nongridded` and `bint_testing_gridded`, also compiled unit tests, but never run the unit tests
--> removed dependency on unit test target
--> added a separate make target "run_tests" which compiles and runs the STEPWAT2 unit tests

Note:
The warning "SW_Main_lib.c:56:6: warning: no previous prototype for function 'usage' [-Wmissing-prototypes]" is fixed with SOILWAT2 commit a44e5688e7799c44b72b017a724ee7ee857531cc (dev-branch enhance_petfunc)
dschlaep added a commit to DrylandEcology/STEPWAT2 that referenced this issue Jul 21, 2020
Use SOILWAT2's makefile to compile a SOILWAT2 library
Addressing issue #483 and contribute to DrylandEcology/SOILWAT2#89
@dschlaep dschlaep modified the milestones: Clean code, Release v7.0.0 Jul 29, 2022
dschlaep added a commit that referenced this issue Dec 22, 2022
- addressing #89

- `git mv previous_path target_path` to "rename" folders and files without losing git history

- external: googletest and pcg submodules
- src: SOILWAT2 source code
- include: SOILWAT2 header files
- tests/example: example inputs for a SOILWAT2 run, previously "testing"
- tests/gtests: unit tests based on googletest, previously "test"

- note: additional commits to complete #89 will need to update file path names, makefile, etc.
dschlaep added a commit that referenced this issue Dec 22, 2022
- addressing #89

- update file paths (see previous commit 90b1741 "Re-organize repository (part 1)"

- note: additional commits to complete #89 will need to update makefile and scripts
dschlaep added a commit that referenced this issue Dec 22, 2022
- address #89

- update makefiles, scripts, and continuous integration setup

(see previous commit 90b1741 "Re-organize repository (part 1)"
(see previous commit dc521a4 "Re-organize repository (part 2)"
dschlaep added a commit that referenced this issue Jun 9, 2023
Release v7.0.0

see https://github.com/DrylandEcology/SOILWAT2/milestone/13

- Read daily weather before the simulations enhancement (#311)
- Calculate climate variables before simulation loop (#317)
- Estimate vegetation cover from climate before simulation run (#318)
- Implement multiple soil water retention curves (#315)
- Soil density: input either for < 2 mm fraction or for whole soil? enhancement (#280)
- Re-organize repository with more sub-folders question (#89)
- Daily variables for atmospheric demand (#341)
- STEPWAT2 updated to work with this release (see DrylandEcology/STEPWAT2#535)
- rSOILWAT2 updated to work with this release (see DrylandEcology/rSOILWAT2#214)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants