Open AlexanderJuestel opened 2 years ago
Repository: Is the source for this learning module available at the repository url?
The repository is available at the following URL: https://github.com/cgre-aachen/gemgis_data
License: Does the repository contain a plain-text LICENSE file with the contents of a standard license? (OSI-approved for code, Creative Commons for content)
The Licence can be found here: https://github.com/cgre-aachen/gemgis_data/blob/main/LICENSE
Version: Does the release version given match the repository release (v0.5)?
The release version will be v0.1 upon submitting the paper
Authorship: Has the submitting author (@AlexanderJuestel ) made visible contributions to the module? Does the full list of authors seem appropriate and complete?
Yes, @AlexanderJuestel has made visible contributions. The full list of authors include most of the GemPy and GemGIS authors
A statement of need: Do the authors clearly state the need for this module and who the target audience is?
Yes, need is stated to explore the subsurface and target audience are students people interested in Geomodeling.
Installation instructions: Is there a clearly stated list of dependencies?
The data repository mainly depends on GemGIS and GemPy. Their installation and documentation are linked in the readme. The list of dependencies can also be found in the respective requirement files
Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the module 2) Report issues or problems with the module 3) Seek support
The link to the Contribution/Community Guidelines is here: https://github.com/cgre-aachen/gemgis_data/blob/main/CONTRIBUTING.md
Authors: Does the paper.md file include a list of authors with their affiliations?
Yes
Review checklist
Conflict of interest
Code of Conduct
General checks
[x] Repository: Is the source for this learning module available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of a standard license? (OSI-approved for code, Creative Commons for content)
[x] Version: Does the release version given match the repository release (v0.5)?
[x] Authorship: Has the submitting author (@AlexanderJuestel ) made visible contributions to the module? Does the full list of authors seem appropriate and complete?
Documentation
[x] A statement of need: Do the authors clearly state the need for this module and who the target audience is?
[x] Installation instructions: Is there a clearly stated list of dependencies?
[x] Usage: Does the documentation explain how someone would adopt the module, and include examples of how to use it?
[x] Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the module 2) Report issues or problems with the module 3) Seek support
Pedagogy / Instructional design (Work-in-progress: reviewers, please comment!)
[x] Learning objectives: Does the module make the learning objectives plainly clear? (We don't require explicitly written learning objectives; only that they be evident from content and design.)
[x] Content scope and length: Is the content substantial for learning a given topic? Is the length of the module appropriate?
[x] Pedagogy: Does the module seem easy to follow? Does it observe guidance on cognitive load? (working memory limits of 7 +/- 2 chunks of information)
[x] Content quality: Is the writing of good quality, concise, engaging? Are the code components well crafted? Does the module seem complete?
[x] Instructional design: Is the instructional design deliberate and apparent? For example, exploit worked-example effects; effective multi-media use; low extraneous cognitive load.
JOSE paper
[x] Authors: Does the paper.md file include a list of authors with their affiliations?
[x] A statement of need: Does the paper clearly state the need for this module and who the target audience is?
[x] Description: Does the paper describe the learning materials and sequence?
[x] Does it describe how it has been used in the classroom or other settings, and how someone might adopt it?
[x] Could someone else teach with this module, given the right expertise?
[x] Does the paper tell the "story" of how the authors came to develop it, or what their expertise is?
[x] References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?