From d0aec7367fbd73673b52ce6c25e822e6cb237459 Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 3 Aug 2023 16:24:14 -0400 Subject: [PATCH 01/14] pull CMakeLists.txt and LICENSE to top-level --- src/CMakeLists.txt => CMakeLists.txt | 54 ++++++++++++++-------------- src/LICENSE => LICENSE | 0 2 files changed, 27 insertions(+), 27 deletions(-) rename src/CMakeLists.txt => CMakeLists.txt (88%) rename src/LICENSE => LICENSE (100%) diff --git a/src/CMakeLists.txt b/CMakeLists.txt similarity index 88% rename from src/CMakeLists.txt rename to CMakeLists.txt index 37dcb71..6664636 100644 --- a/src/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,27 +1,27 @@ -cmake_minimum_required(VERSION 3.20) -# made with help from Zhu Liang-Jun of IGSNRR in Beijing - -# Setup Project -PROJECT(Raven CXX) - -# Find NetCDF -find_package(NetCDF) -# find header & source -file(GLOB HEADER "*.h") -file(GLOB SOURCE "*.cpp") - -add_executable(Raven - ${SOURCE} - ${HEADER} -) -source_group("Header Files" FILES ${HEADER}) -source_group("Source Files" FILES ${SOURCE}) - -IF(NETCDF_FOUND) - message("${NETCDF_INCLUDES}") - add_definitions(-Dnetcdf) - include_directories(${NETCDF_INCLUDES}) - target_link_libraries(Raven ${NETCDF_LIBRARIES}) -ENDIF() - -set_target_properties(Raven PROPERTIES LINKER_LANGUAGE CXX) +cmake_minimum_required(VERSION 3.20) +# made with help from Zhu Liang-Jun of IGSNRR in Beijing + +# Setup Project +PROJECT(Raven CXX) + +# Find NetCDF +find_package(NetCDF) +# find header & source +file(GLOB HEADER "src/*.h") +file(GLOB SOURCE "src/*.cpp") + +add_executable(Raven + ${SOURCE} + ${HEADER} +) +source_group("Header Files" FILES ${HEADER}) +source_group("Source Files" FILES ${SOURCE}) + +IF(NETCDF_FOUND) + message("${NETCDF_INCLUDES}") + add_definitions(-Dnetcdf) + include_directories(${NETCDF_INCLUDES}) + target_link_libraries(Raven ${NETCDF_LIBRARIES}) +ENDIF() + +set_target_properties(Raven PROPERTIES LINKER_LANGUAGE CXX) diff --git a/src/LICENSE b/LICENSE similarity index 100% rename from src/LICENSE rename to LICENSE From c332b85afc4818aa5cbaba51b76ad91eb9a1bcde Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 3 Aug 2023 16:25:34 -0400 Subject: [PATCH 02/14] Add a pull request template, a first_pull_request action, add an AUTHORS.md, add a CONTRIBUTING.md with lorem ipsum --- .github/PULL_REQUEST_TEMPLATE.md | 20 +++++++++++ .github/workflows/first_pull_request.yml | 46 ++++++++++++++++++++++++ AUTHORS.md | 13 +++++++ CONTRIBUTING.md | 25 +++++++++++++ 4 files changed, 104 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/first_pull_request.yml create mode 100644 AUTHORS.md create mode 100644 CONTRIBUTING.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e1f306c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ + + +### Pull Request Checklist: +- [ ] This PR addresses an already opened issue (for bug fixes / features) + - This PR fixes #xyz +- [ ] Tests for the changes have been added (for bug fixes / features) + - [ ] (If applicable) Documentation has been added / updated (for bug fixes / features) +- [ ] CHANGES.rst has been updated (with summary of main changes) + +### What kind of change does this PR introduce? + + * ... + +### Does this PR introduce a breaking change? + + + * ... + +### Other information: + diff --git a/.github/workflows/first_pull_request.yml b/.github/workflows/first_pull_request.yml new file mode 100644 index 0000000..15dee34 --- /dev/null +++ b/.github/workflows/first_pull_request.yml @@ -0,0 +1,46 @@ +name: First Pull Request + +on: + pull_request_target: + types: + - opened + +jobs: + welcome: + name: Welcome + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@v6 + with: + script: | + // Get a list of all issues created by the PR opener + // See: https://octokit.github.io/rest.js/#pagination + const creator = context.payload.sender.login + const opts = github.rest.issues.listForRepo.endpoint.merge({ + ...context.issue, + creator, + state: 'all' + }) + const issues = await github.paginate(opts) + + for (const issue of issues) { + if (issue.number === context.issue.number) { + continue + } + + if (issue.pull_request) { + return // Creator is already a contributor. + } + } + + await github.rest.issues.createComment({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + body: `**Welcome**, new contributor! + + It appears that this is your first Pull Request. To give credit where it's due, we ask that you add your information to the \`AUTHORS.md\` and \`.zenodo.json\`: + - [ ] The relevant author information has been added to \`AUTHORS.md\` and \`.zenodo.json\` + + Please make sure you've read our [contributing guide](CONTRIBUTING.md). We look forward to reviewing your Pull Request shortly ✨` + }) \ No newline at end of file diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..7e34bd0 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,13 @@ +# Credits + +## Development Lead + +* James Craig @analytophile + +## Co-Developers + +* David Huard @huard + +## Contributors + +* Trevor James Smith @Zeitsperre \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..84c070b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contribution Guidelines + +## Contributor Licensing Agreement + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Mus mauris vitae ultricies leo integer malesuada nunc vel. Cras pulvinar mattis nunc sed blandit libero volutpat sed. Elit eget gravida cum sociis natoque. Nunc mattis enim ut tellus elementum sagittis vitae et leo. Urna neque viverra justo nec ultrices dui sapien eget mi. Proin nibh nisl condimentum id venenatis a condimentum vitae. Scelerisque eleifend donec pretium vulputate sapien. Venenatis tellus in metus vulputate eu. Auctor urna nunc id cursus metus aliquam. Leo vel orci porta non pulvinar neque laoreet suspendisse. Facilisi cras fermentum odio eu feugiat pretium nibh ipsum consequat. + +## Pull Requests + +Sagittis vitae et leo duis ut diam quam nulla. Scelerisque varius morbi enim nunc faucibus a pellentesque sit. Aliquet nec ullamcorper sit amet risus nullam eget felis eget. Cras adipiscing enim eu turpis. Purus sit amet volutpat consequat mauris nunc congue nisi vitae. Varius morbi enim nunc faucibus a. Blandit volutpat maecenas volutpat blandit aliquam etiam erat velit scelerisque. Aliquet enim tortor at auctor. Est placerat in egestas erat imperdiet sed euismod nisi porta. Metus aliquam eleifend mi in nulla posuere sollicitudin aliquam. Volutpat consequat mauris nunc congue nisi. + +### Styling + +Amet purus gravida quis blandit turpis cursus in hac. Blandit volutpat maecenas volutpat blandit aliquam. Aliquam sem fringilla ut morbi. Nisl vel pretium lectus quam id leo in. + +### Documentation + +Elit scelerisque mauris pellentesque pulvinar pellentesque habitant morbi tristique senectus. Tortor consequat id porta nibh venenatis cras sed felis. Purus viverra accumsan in nisl nisi scelerisque. + +### Testing + +Rutrum tellus pellentesque eu tincidunt tortor aliquam. Rhoncus urna neque viverra justo nec ultrices dui sapien eget. Mattis enim ut tellus elementum. + +### Commit Messages + +Condimentum vitae sapien pellentesque habitant morbi tristique senectus. Mauris augue neque gravida in fermentum et sollicitudin ac. Sed turpis tincidunt id aliquet risus feugiat. \ No newline at end of file From 753d7beb5bff309566019f695f5261938110d799 Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 3 Aug 2023 16:27:12 -0400 Subject: [PATCH 03/14] README.md formatting --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8a33495..526357b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # RavenHydroFramework -The code repository for the Raven Hydrological Modelling Framework developed at the University of Waterloo -Release versions, tutorials, documentation, and more distributed at [the Raven website](http://raven.uwaterloo.ca/Main.html) +The code repository for the Raven Hydrological Modelling Framework developed at the University of Waterloo. -Intended for use with Visual Studio Community Edition 2021, but also provided with Windows/linux/unix/MacOS g++ makefile and CMake configuration file. +Release versions, tutorials, documentation, and more distributed at [the Raven website](http://raven.uwaterloo.ca/Main.html). -Note unconventional two-space tabbing conventions. If you would like to work with the active development of Raven's core, please do so on a -branch and coordinate commits to the trunk with the Raven development team. Please contact us while you're at it - we love to have people helping out. +Intended for use with Visual Studio Community Edition 2021, but also provided with Windows/linux/unix/MacOS g++ makefile and CMake configuration file. + +Note unconventional two-space tabbing conventions. +If you would like to work with the active development of Raven's core, please do so on a branch and coordinate commits to the trunk with the Raven development team. + +Please contact us while you're at it - we love to have people helping out. From ebc06c94722fd7eabc9d728b6fdba23a7b94787f Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 3 Aug 2023 16:49:27 -0400 Subject: [PATCH 04/14] add issue templates --- .../0001-GENERIC-ISSUE-TEMPLATE.yml | 30 ++++++++++++++ .github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml | 40 +++++++++++++++++++ .../ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml | 31 ++++++++++++++ .../ISSUE_TEMPLATE/0004-QUESTION-SUPPORT.yml | 21 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 5 files changed, 123 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml create mode 100644 .github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/0004-QUESTION-SUPPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml b/.github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml new file mode 100644 index 0000000..830e7cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml @@ -0,0 +1,30 @@ +name: Generic issue template +description: For detailing generic/uncategorized issues in Xclim + +body: + - type: textarea + id: generic-issue + attributes: + label: Generic Issue + description: Please fill in the following information fields as needed. + value: | + * Raven version: + * Operating System: + + ### Description + + + ### What I Did + + ``` + $ raven --foo bar + ``` + + ### What I Received + + ``` + Exception occurred + Math error: Attempted to divide by Zero + ``` diff --git a/.github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml new file mode 100644 index 0000000..ce9ea91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml @@ -0,0 +1,40 @@ +name: Bug report +description: Help us improve Xclim +labels: [ "bug" ] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: setup-information + attributes: + label: Setup Information + description: | + What software versions are you running? + value: | + - Raven version: + - Operating System: + - type: textarea + id: description + attributes: + label: Description + description: Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen. + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps To Reproduce + description: Paste the command(s) you ran and the output. If there was a crash, please include the traceback below. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the problem here. + - type: checkboxes + id: submit-pr + attributes: + label: Contribution + description: Do you intend to submit a fix for this bug? (The xclim developers will help with code compliance) + options: + - label: I would be willing/able to open a Pull Request to address this bug. diff --git a/.github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml new file mode 100644 index 0000000..22fadf4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml @@ -0,0 +1,31 @@ +name: Feature request +description: Suggest an idea for this project +labels: [ "enhancement" ] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: problem + attributes: + label: Addressing a Problem? + description: Is your feature request related to a problem? Please describe it. + - type: textarea + id: potential-solution + attributes: + label: Potential Solution + description: Describe the solution you'd like to see implemented. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the feature request here. + - type: checkboxes + id: submit-pr + attributes: + label: Contribution + description: Do you intend to submit a fix for this bug? (The xclim developers will help with code compliance) + options: + - label: I would be willing/able to open a Pull Request to contribute this feature. diff --git a/.github/ISSUE_TEMPLATE/0004-QUESTION-SUPPORT.yml b/.github/ISSUE_TEMPLATE/0004-QUESTION-SUPPORT.yml new file mode 100644 index 0000000..da85eb4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0004-QUESTION-SUPPORT.yml @@ -0,0 +1,21 @@ +name: Question/Support +description: Ask for help from the developers +labels: [ "support" ] + +body: + - type: textarea + id: setup-information + attributes: + label: Setup Information + description: | + What software versions are you running? + value: | + - Raven version: + - Operating System: + - type: textarea + id: description + attributes: + label: Context + description: Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen. + value: | + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a49eab2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file From 80a470c7c20bfb26ff3f96d0ae3920fc60843b1e Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 3 Aug 2023 17:02:26 -0400 Subject: [PATCH 05/14] stage Zenodo configuration - many missing authors --- .zenodo.json | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .zenodo.json diff --git a/.zenodo.json b/.zenodo.json new file mode 100644 index 0000000..cf7ef16 --- /dev/null +++ b/.zenodo.json @@ -0,0 +1,52 @@ +{ + "title": "Raven Hydrological Modelling Framework", + "creators": [ + { + "name": "Craig, James", + "affiliation": "University of Waterloo", + "orcid": "0000-0003-2715-7166" + }, + { + "name": "Mai, Juliane", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-1132-2342" + }, + { + "name": "Arsenault, Richard", + "affiliation": "École de technologie supérieure", + "orcid": "0000-0003-2834-2750" + }, + { + "name": "Huard, David", + "affiliation": "Ouranos", + "orcid": "0000-0003-0311-5498" + }, + { + "name": "Jauvin, Christian", + "affiliation": "K2 Geospatial", + "orcid": "0000-0002-2257-5636" + }, + { + "name": "Smith, Trevor James", + "affiliation": "Ouranos", + "orcid": "0000-0001-5393-8359" + } + ], + "keywords": [ + "hydrological framework", + "hydrology", + "modelling", + "prediction", + "raven", + "simulation" + ], + "license": "Artistic-2.0", + "language": "eng", + "communities": [ + { + "identifier": "ouranos" + } + ], + "upload_type": "software", + "access_right": "open" +} \ No newline at end of file From 6118bffc9c82be8ed9420e44e8d1fa76f260a3a7 Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 3 Aug 2023 17:10:14 -0400 Subject: [PATCH 06/14] typo fix --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e1f306c..b0616c6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,7 +12,7 @@ * ... ### Does this PR introduce a breaking change? - + * ... From db7fc03cd5f1656fb744ec2b026ca705cc7d43b6 Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 3 Aug 2023 17:15:17 -0400 Subject: [PATCH 07/14] update CHANGES.md --- CHANGES.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 CHANGES.md diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..cb0d33e --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,12 @@ +# Changelog + +## [Unreleased] + +* Added GitHub Issue Templates, Pull Request Template, and Contributing Guidelines. +* Added a GitHub Workflow for welcoming new contributors. +* Moved CMakeLists and License to top-level. +* Added an AUTHORS.md, CHANGES.md, and a Zenodo configuration file. + +## v3.7 (2023-08-03) + +* Migrated code base from SVN to Git (GitHub). From 5e0416b4147316f1ea7d162372643a19467bc793 Mon Sep 17 00:00:00 2001 From: richardarsenault <39815445+richardarsenault@users.noreply.github.com> Date: Fri, 4 Aug 2023 11:01:13 -0400 Subject: [PATCH 08/14] Update list of authors and collaborators with ORCID From a9e979b57da17f7b9ba4606f4d7915c53d5a32a1 Mon Sep 17 00:00:00 2001 From: richardarsenault <39815445+richardarsenault@users.noreply.github.com> Date: Fri, 4 Aug 2023 11:09:14 -0400 Subject: [PATCH 09/14] Updated list of authors and collaborators --- .zenodo.json | 220 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 169 insertions(+), 51 deletions(-) diff --git a/.zenodo.json b/.zenodo.json index cf7ef16..56d0d54 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -1,52 +1,170 @@ -{ - "title": "Raven Hydrological Modelling Framework", - "creators": [ - { - "name": "Craig, James", - "affiliation": "University of Waterloo", - "orcid": "0000-0003-2715-7166" - }, - { - "name": "Mai, Juliane", - "affiliation": "University of Waterloo", - "orcid": "0000-0002-1132-2342" - }, - { - "name": "Arsenault, Richard", - "affiliation": "École de technologie supérieure", - "orcid": "0000-0003-2834-2750" - }, - { - "name": "Huard, David", - "affiliation": "Ouranos", - "orcid": "0000-0003-0311-5498" - }, - { - "name": "Jauvin, Christian", - "affiliation": "K2 Geospatial", - "orcid": "0000-0002-2257-5636" - }, - { - "name": "Smith, Trevor James", - "affiliation": "Ouranos", - "orcid": "0000-0001-5393-8359" - } - ], - "keywords": [ - "hydrological framework", - "hydrology", - "modelling", - "prediction", - "raven", - "simulation" - ], - "license": "Artistic-2.0", - "language": "eng", - "communities": [ - { - "identifier": "ouranos" - } - ], - "upload_type": "software", - "access_right": "open" +{ + "title": "Raven Hydrological Modelling Framework", + "creators": [ + { + "name": "Craig, James", + "affiliation": "University of Waterloo", + "orcid": "0000-0003-2715-7166" + }, + { + "name": "Chlumsky, Robert", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-1303-5064" + }, + { + "name": "Jenkinson, Wayne", + "affiliation": "International Joint Commission", + }, + { + "name": "Georg Jost", + "affiliation": "BC Hydro", + }, + { + "name": "Mai, Juliane", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-1132-2342" + }, + { + "name": "Scantlebury, Leland", + "affiliation": "University of California Davis", + "orcid": "0000-0002-6770-063X" + }, + { + "name": "Serrer, Martin", + "affiliation": "National Research Council", + }, + { + "name": "Sgro, Nicholas", + "affiliation": "Geofirma Engineering Ltd", + }, + { + "name": "Snowdon, Andrew P.", + "affiliation": "University of Waterloo", + "orcid": "0000-0003-3698-6177", + }, + { + "name": "Tolson, Bryan", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-3092-5536", + }, + { + "name": "Arabzadeh, Rezgar", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-1775-1076", + }, + { + "name": "Arsenault, Richard", + "affiliation": "École de technologie supérieure", + "orcid": "0000-0003-2834-2750", + }, + { + "name": "Basu, Nandita B.", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-8867-8523", + }, + { + "name": "Brown, Genevieve", + "affiliation": "University of Waterloo", + }, + { + "name": "Burdett, Hannah", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-8144-9584", + }, + { + "name": "Kheydr, Ayman", + "affiliation": "University of Waterloo", + }, + { + "name": "Han, Ming", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-7258-2121", + }, + { + "name": "Huard, David", + "affiliation": "Ouranos", + "orcid": "0000-0003-0311-5498", + }, + { + "name": "Huang, Susan", + }, + { + "name": "Jauvin, Christian", + "affiliation": "K2 Geospatial", + "orcid": "0000-0002-2257-5636", + }, + { + "name": "Lapointe, Francis", + "affiliation": "Université de Sherbrooke", + "orcid": "0000-0002-7638-4018", + }, + { + "name": "Lee, Konhee", + "affiliation": "Ontario Power Generation", + "orcid": "0000-0003-0494-6015", + }, + { + "name": "Lin, Simon G.M.", + "affiliation": "University of Waterloo", + "orcid": "0000-0001-5261-4977", + }, + { + "name": "Shafii, Mahyar", + "affiliation": "University of Waterloo", + "orcid": "0000-0002-8303-1253", + }, + { + "name": "Pearson, Stuart", + "affiliation": "Delft University of Technology", + "orcid": "0000-0002-3986-4469", + }, + { + "name": "Smith, Trevor James", + "affiliation": "Ouranos", + "orcid": "0000-0001-5393-8359", + }, + { + "name": "Spraakman, Sylvie", + "affiliation": "City of Vancouver", + "orcid": "0000-0002-4474-4074", + }, + { + "name": "Stonebridge, Graham", + "affiliation": "University of Waterloo, Aquanty", + }, + { + "name": "Taheri, Mahkameh", + "affiliation": "Hatch Canada", + "orcid": "0000-0003-0604-5982", + }, + { + "name": "Werstuck, Connor", + "affiliation": "Ontario Power Generation", + }, + { + "name": "Zhang, Cloud", + "affiliation": "Andrews.engineer", + }, + { + "name": "Zorn, Nicholas", + "affiliation": "Morrison Hershfield", + }, + ], + "keywords": [ + "hydrological framework", + "hydrology", + "modelling", + "prediction", + "raven", + "simulation" + ], + "license": "Artistic-2.0", + "language": "eng", + "communities": [ + { + "identifier": "ouranos" + } + ], + "upload_type": "software", + "access_right": "open" } \ No newline at end of file From 8238aac2210745ba590d6b299a77ed9ae855f436 Mon Sep 17 00:00:00 2001 From: James Craig <32948958+analytophile@users.noreply.github.com> Date: Fri, 4 Aug 2023 11:29:25 -0400 Subject: [PATCH 10/14] Update AUTHORS.md added additional authors Rob & Julie --- AUTHORS.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index 7e34bd0..80d40ff 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -2,12 +2,14 @@ ## Development Lead -* James Craig @analytophile +* James R Craig @analytophile ## Co-Developers +* Robert Chlumsky @rchlumsk * David Huard @huard +* Juliane Mai @julemai ## Contributors -* Trevor James Smith @Zeitsperre \ No newline at end of file +* Trevor James Smith @Zeitsperre From 26b1099325f8c0f792688e5e63f226e8b1072a13 Mon Sep 17 00:00:00 2001 From: James Craig <32948958+analytophile@users.noreply.github.com> Date: Fri, 4 Aug 2023 11:48:18 -0400 Subject: [PATCH 11/14] Delete CHANGES.md --- CHANGES.md | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 CHANGES.md diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 index cb0d33e..0000000 --- a/CHANGES.md +++ /dev/null @@ -1,12 +0,0 @@ -# Changelog - -## [Unreleased] - -* Added GitHub Issue Templates, Pull Request Template, and Contributing Guidelines. -* Added a GitHub Workflow for welcoming new contributors. -* Moved CMakeLists and License to top-level. -* Added an AUTHORS.md, CHANGES.md, and a Zenodo configuration file. - -## v3.7 (2023-08-03) - -* Migrated code base from SVN to Git (GitHub). From c41016056579a64a977c5427796173af095476b5 Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Fri, 4 Aug 2023 11:57:47 -0400 Subject: [PATCH 12/14] add locations to affiliations --- .zenodo.json | 100 +++++++++++++++++++++++++-------------------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/.zenodo.json b/.zenodo.json index 56d0d54..853259a 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -3,152 +3,152 @@ "creators": [ { "name": "Craig, James", - "affiliation": "University of Waterloo", + "affiliation": "University of Waterloo, Ontario, Canada", "orcid": "0000-0003-2715-7166" }, { "name": "Chlumsky, Robert", - "affiliation": "University of Waterloo", + "affiliation": "University of Waterloo, Ontario, Canada", "orcid": "0000-0002-1303-5064" }, { "name": "Jenkinson, Wayne", - "affiliation": "International Joint Commission", + "affiliation": "International Joint Commission, Ottawa, Ontario, Canada" }, { "name": "Georg Jost", - "affiliation": "BC Hydro", + "affiliation": "BC Hydro, British Columbia, Canada" }, { "name": "Mai, Juliane", - "affiliation": "University of Waterloo", + "affiliation": "University of Waterloo, Ontario, Canada", "orcid": "0000-0002-1132-2342" }, { "name": "Scantlebury, Leland", - "affiliation": "University of California Davis", + "affiliation": "University of California Davis, California, USA", "orcid": "0000-0002-6770-063X" }, { "name": "Serrer, Martin", - "affiliation": "National Research Council", + "affiliation": "National Research Council, Ottawa, Ontario, Canada" }, { "name": "Sgro, Nicholas", - "affiliation": "Geofirma Engineering Ltd", + "affiliation": "Geofirma Engineering Ltd., Ottawa, Ontario, Canada" }, { "name": "Snowdon, Andrew P.", - "affiliation": "University of Waterloo", - "orcid": "0000-0003-3698-6177", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0003-3698-6177" }, { "name": "Tolson, Bryan", - "affiliation": "University of Waterloo", - "orcid": "0000-0002-3092-5536", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-3092-5536" }, { "name": "Arabzadeh, Rezgar", - "affiliation": "University of Waterloo", - "orcid": "0000-0002-1775-1076", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-1775-1076" }, { "name": "Arsenault, Richard", - "affiliation": "École de technologie supérieure", - "orcid": "0000-0003-2834-2750", + "affiliation": "École de technologie supérieure, Montréal, Québec, Canada", + "orcid": "0000-0003-2834-2750" }, { "name": "Basu, Nandita B.", - "affiliation": "University of Waterloo", - "orcid": "0000-0002-8867-8523", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-8867-8523" }, { "name": "Brown, Genevieve", - "affiliation": "University of Waterloo", + "affiliation": "University of Waterloo, Ontario, Canada" }, { "name": "Burdett, Hannah", - "affiliation": "University of Waterloo", - "orcid": "0000-0002-8144-9584", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-8144-9584" }, { "name": "Kheydr, Ayman", - "affiliation": "University of Waterloo", + "affiliation": "University of Waterloo, Ontario, Canada" }, { "name": "Han, Ming", - "affiliation": "University of Waterloo", - "orcid": "0000-0002-7258-2121", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-7258-2121" }, { "name": "Huard, David", - "affiliation": "Ouranos", - "orcid": "0000-0003-0311-5498", + "affiliation": "Ouranos Inc., Montréal, Québec, Canada", + "orcid": "0000-0003-0311-5498" }, { - "name": "Huang, Susan", + "name": "Huang, Susan" }, { "name": "Jauvin, Christian", - "affiliation": "K2 Geospatial", - "orcid": "0000-0002-2257-5636", + "affiliation": "K2 Geospatial, Montréal, Québec, Canada", + "orcid": "0000-0002-2257-5636" }, { "name": "Lapointe, Francis", - "affiliation": "Université de Sherbrooke", - "orcid": "0000-0002-7638-4018", + "affiliation": "Université de Sherbrooke, Québec, Canada", + "orcid": "0000-0002-7638-4018" }, { "name": "Lee, Konhee", - "affiliation": "Ontario Power Generation", - "orcid": "0000-0003-0494-6015", + "affiliation": "Ontario Power Generation, Toronto, Ontario, Canada", + "orcid": "0000-0003-0494-6015" }, { "name": "Lin, Simon G.M.", - "affiliation": "University of Waterloo", - "orcid": "0000-0001-5261-4977", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0001-5261-4977" }, { "name": "Shafii, Mahyar", - "affiliation": "University of Waterloo", - "orcid": "0000-0002-8303-1253", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-8303-1253" }, { "name": "Pearson, Stuart", - "affiliation": "Delft University of Technology", - "orcid": "0000-0002-3986-4469", + "affiliation": "Delft University of Technology, The Netherlands", + "orcid": "0000-0002-3986-4469" }, { "name": "Smith, Trevor James", - "affiliation": "Ouranos", - "orcid": "0000-0001-5393-8359", + "affiliation": "Ouranos Inc., Montréal, Québec, Canada", + "orcid": "0000-0001-5393-8359" }, { "name": "Spraakman, Sylvie", - "affiliation": "City of Vancouver", - "orcid": "0000-0002-4474-4074", + "affiliation": "City of Vancouver, British Columbia, Canada", + "orcid": "0000-0002-4474-4074" }, { "name": "Stonebridge, Graham", - "affiliation": "University of Waterloo, Aquanty", + "affiliation": "University of Waterloo, Ontario, Canada, and Aquanty Inc., Ontario, Canada" }, { "name": "Taheri, Mahkameh", - "affiliation": "Hatch Canada", - "orcid": "0000-0003-0604-5982", + "affiliation": "Hatch Canada Ltd., Etobicoke, Ontario, Canada", + "orcid": "0000-0003-0604-5982" }, { "name": "Werstuck, Connor", - "affiliation": "Ontario Power Generation", + "affiliation": "Ontario Power Generation, Ontario, Canada" }, { "name": "Zhang, Cloud", - "affiliation": "Andrews.engineer", + "affiliation": "Andrews.engineer, Ontario, Canada" }, { "name": "Zorn, Nicholas", - "affiliation": "Morrison Hershfield", - }, + "affiliation": "Morrison Hershfield, Toronto, Ontario, Canada" + } ], "keywords": [ "hydrological framework", From cbb11902903c3ed4136876bbd2aa5b94714893a9 Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Fri, 4 Aug 2023 12:15:32 -0400 Subject: [PATCH 13/14] add a pre-commit configuration for validating JSON configurations and ensuring that GitHub Workflows are valid --- .pre-commit-config.yaml | 30 ++++ .zenodo.json | 340 ++++++++++++++++++++-------------------- 2 files changed, 200 insertions(+), 170 deletions(-) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..732767f --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,30 @@ +default_language_version: + python: python3 + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: check-json + - id: pretty-format-json + args: ['--autofix', '--no-ensure-ascii', '--no-sort-keys'] + - repo: https://github.com/python-jsonschema/check-jsonschema + rev: 0.23.3 + hooks: + - id: check-github-workflows + - repo: meta + hooks: + - id: check-hooks-apply + - id: check-useless-excludes + +ci: + autofix_commit_msg: | + [pre-commit.ci] auto fixes from pre-commit.com hooks + + for more information, see https://pre-commit.ci + autofix_prs: true + autoupdate_branch: '' + autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate' + autoupdate_schedule: quarterly + skip: [ ] + submodules: false \ No newline at end of file diff --git a/.zenodo.json b/.zenodo.json index 853259a..49efb66 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -1,170 +1,170 @@ -{ - "title": "Raven Hydrological Modelling Framework", - "creators": [ - { - "name": "Craig, James", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0003-2715-7166" - }, - { - "name": "Chlumsky, Robert", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-1303-5064" - }, - { - "name": "Jenkinson, Wayne", - "affiliation": "International Joint Commission, Ottawa, Ontario, Canada" - }, - { - "name": "Georg Jost", - "affiliation": "BC Hydro, British Columbia, Canada" - }, - { - "name": "Mai, Juliane", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-1132-2342" - }, - { - "name": "Scantlebury, Leland", - "affiliation": "University of California Davis, California, USA", - "orcid": "0000-0002-6770-063X" - }, - { - "name": "Serrer, Martin", - "affiliation": "National Research Council, Ottawa, Ontario, Canada" - }, - { - "name": "Sgro, Nicholas", - "affiliation": "Geofirma Engineering Ltd., Ottawa, Ontario, Canada" - }, - { - "name": "Snowdon, Andrew P.", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0003-3698-6177" - }, - { - "name": "Tolson, Bryan", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-3092-5536" - }, - { - "name": "Arabzadeh, Rezgar", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-1775-1076" - }, - { - "name": "Arsenault, Richard", - "affiliation": "École de technologie supérieure, Montréal, Québec, Canada", - "orcid": "0000-0003-2834-2750" - }, - { - "name": "Basu, Nandita B.", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-8867-8523" - }, - { - "name": "Brown, Genevieve", - "affiliation": "University of Waterloo, Ontario, Canada" - }, - { - "name": "Burdett, Hannah", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-8144-9584" - }, - { - "name": "Kheydr, Ayman", - "affiliation": "University of Waterloo, Ontario, Canada" - }, - { - "name": "Han, Ming", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-7258-2121" - }, - { - "name": "Huard, David", - "affiliation": "Ouranos Inc., Montréal, Québec, Canada", - "orcid": "0000-0003-0311-5498" - }, - { - "name": "Huang, Susan" - }, - { - "name": "Jauvin, Christian", - "affiliation": "K2 Geospatial, Montréal, Québec, Canada", - "orcid": "0000-0002-2257-5636" - }, - { - "name": "Lapointe, Francis", - "affiliation": "Université de Sherbrooke, Québec, Canada", - "orcid": "0000-0002-7638-4018" - }, - { - "name": "Lee, Konhee", - "affiliation": "Ontario Power Generation, Toronto, Ontario, Canada", - "orcid": "0000-0003-0494-6015" - }, - { - "name": "Lin, Simon G.M.", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0001-5261-4977" - }, - { - "name": "Shafii, Mahyar", - "affiliation": "University of Waterloo, Ontario, Canada", - "orcid": "0000-0002-8303-1253" - }, - { - "name": "Pearson, Stuart", - "affiliation": "Delft University of Technology, The Netherlands", - "orcid": "0000-0002-3986-4469" - }, - { - "name": "Smith, Trevor James", - "affiliation": "Ouranos Inc., Montréal, Québec, Canada", - "orcid": "0000-0001-5393-8359" - }, - { - "name": "Spraakman, Sylvie", - "affiliation": "City of Vancouver, British Columbia, Canada", - "orcid": "0000-0002-4474-4074" - }, - { - "name": "Stonebridge, Graham", - "affiliation": "University of Waterloo, Ontario, Canada, and Aquanty Inc., Ontario, Canada" - }, - { - "name": "Taheri, Mahkameh", - "affiliation": "Hatch Canada Ltd., Etobicoke, Ontario, Canada", - "orcid": "0000-0003-0604-5982" - }, - { - "name": "Werstuck, Connor", - "affiliation": "Ontario Power Generation, Ontario, Canada" - }, - { - "name": "Zhang, Cloud", - "affiliation": "Andrews.engineer, Ontario, Canada" - }, - { - "name": "Zorn, Nicholas", - "affiliation": "Morrison Hershfield, Toronto, Ontario, Canada" - } - ], - "keywords": [ - "hydrological framework", - "hydrology", - "modelling", - "prediction", - "raven", - "simulation" - ], - "license": "Artistic-2.0", - "language": "eng", - "communities": [ - { - "identifier": "ouranos" - } - ], - "upload_type": "software", - "access_right": "open" -} \ No newline at end of file +{ + "title": "Raven Hydrological Modelling Framework", + "creators": [ + { + "name": "Craig, James", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0003-2715-7166" + }, + { + "name": "Chlumsky, Robert", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-1303-5064" + }, + { + "name": "Jenkinson, Wayne", + "affiliation": "International Joint Commission, Ottawa, Ontario, Canada" + }, + { + "name": "Georg Jost", + "affiliation": "BC Hydro, British Columbia, Canada" + }, + { + "name": "Mai, Juliane", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-1132-2342" + }, + { + "name": "Scantlebury, Leland", + "affiliation": "University of California Davis, California, USA", + "orcid": "0000-0002-6770-063X" + }, + { + "name": "Serrer, Martin", + "affiliation": "National Research Council, Ottawa, Ontario, Canada" + }, + { + "name": "Sgro, Nicholas", + "affiliation": "Geofirma Engineering Ltd., Ottawa, Ontario, Canada" + }, + { + "name": "Snowdon, Andrew P.", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0003-3698-6177" + }, + { + "name": "Tolson, Bryan", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-3092-5536" + }, + { + "name": "Arabzadeh, Rezgar", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-1775-1076" + }, + { + "name": "Arsenault, Richard", + "affiliation": "École de technologie supérieure, Montréal, Québec, Canada", + "orcid": "0000-0003-2834-2750" + }, + { + "name": "Basu, Nandita B.", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-8867-8523" + }, + { + "name": "Brown, Genevieve", + "affiliation": "University of Waterloo, Ontario, Canada" + }, + { + "name": "Burdett, Hannah", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-8144-9584" + }, + { + "name": "Kheydr, Ayman", + "affiliation": "University of Waterloo, Ontario, Canada" + }, + { + "name": "Han, Ming", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-7258-2121" + }, + { + "name": "Huard, David", + "affiliation": "Ouranos Inc., Montréal, Québec, Canada", + "orcid": "0000-0003-0311-5498" + }, + { + "name": "Huang, Susan" + }, + { + "name": "Jauvin, Christian", + "affiliation": "K2 Geospatial, Montréal, Québec, Canada", + "orcid": "0000-0002-2257-5636" + }, + { + "name": "Lapointe, Francis", + "affiliation": "Université de Sherbrooke, Québec, Canada", + "orcid": "0000-0002-7638-4018" + }, + { + "name": "Lee, Konhee", + "affiliation": "Ontario Power Generation, Toronto, Ontario, Canada", + "orcid": "0000-0003-0494-6015" + }, + { + "name": "Lin, Simon G.M.", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0001-5261-4977" + }, + { + "name": "Shafii, Mahyar", + "affiliation": "University of Waterloo, Ontario, Canada", + "orcid": "0000-0002-8303-1253" + }, + { + "name": "Pearson, Stuart", + "affiliation": "Delft University of Technology, The Netherlands", + "orcid": "0000-0002-3986-4469" + }, + { + "name": "Smith, Trevor James", + "affiliation": "Ouranos Inc., Montréal, Québec, Canada", + "orcid": "0000-0001-5393-8359" + }, + { + "name": "Spraakman, Sylvie", + "affiliation": "City of Vancouver, British Columbia, Canada", + "orcid": "0000-0002-4474-4074" + }, + { + "name": "Stonebridge, Graham", + "affiliation": "University of Waterloo, Ontario, Canada, and Aquanty Inc., Ontario, Canada" + }, + { + "name": "Taheri, Mahkameh", + "affiliation": "Hatch Canada Ltd., Etobicoke, Ontario, Canada", + "orcid": "0000-0003-0604-5982" + }, + { + "name": "Werstuck, Connor", + "affiliation": "Ontario Power Generation, Ontario, Canada" + }, + { + "name": "Zhang, Cloud", + "affiliation": "Andrews.engineer, Ontario, Canada" + }, + { + "name": "Zorn, Nicholas", + "affiliation": "Morrison Hershfield, Toronto, Ontario, Canada" + } + ], + "keywords": [ + "hydrological framework", + "hydrology", + "modelling", + "prediction", + "raven", + "simulation" + ], + "license": "Artistic-2.0", + "language": "eng", + "communities": [ + { + "identifier": "ouranos" + } + ], + "upload_type": "software", + "access_right": "open" +} From b383d7630b9e02a47c9c48b6503e7f29cd3b30eb Mon Sep 17 00:00:00 2001 From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com> Date: Fri, 4 Aug 2023 12:16:54 -0400 Subject: [PATCH 14/14] add missing empty line at end of file --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 732767f..f7fcc92 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -27,4 +27,4 @@ ci: autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate' autoupdate_schedule: quarterly skip: [ ] - submodules: false \ No newline at end of file + submodules: false