cgre-aachen / gemgis_data

This repository contains the data used in GemGIS
GNU Lesser General Public License v3.0
3 stars 3 forks source link

JOSE Checklist #5

Open AlexanderJuestel opened 2 years ago

AlexanderJuestel commented 2 years ago

Review checklist

Conflict of interest

Code of Conduct

General checks

Documentation

Pedagogy / Instructional design (Work-in-progress: reviewers, please comment!)

JOSE paper

AlexanderJuestel commented 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

AlexanderJuestel commented 2 years ago

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

AlexanderJuestel commented 2 years ago

Version: Does the release version given match the repository release (v0.5)?

The release version will be v0.1 upon submitting the paper

AlexanderJuestel commented 2 years ago

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

image

AlexanderJuestel commented 2 years ago

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. image

AlexanderJuestel commented 2 years ago

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

image

AlexanderJuestel commented 2 years ago

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

AlexanderJuestel commented 2 years ago

Authors: Does the paper.md file include a list of authors with their affiliations?

Yes

image