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

add link to DeepField #222

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Conversation

DeepFieldAdmin
Copy link
Contributor

Add https://github.com/deepfield-team/DeepField to the list of reservoir engineering tools

Project name: DeepField

__Project website/repository:__https://github.com/deepfield-team/DeepField

__License:__MIT

Submission type:

New Software Project

Checklist for all pull requests:

  • The project is open-source and accessible.
  • Searched the existing entries to make sure this is not a duplicate.
  • Contains only a single addition (make separate PRs if adding more than one).
  • Added the link to the bottom of the relevant category.
  • Created a new category only if necessary.
  • Add icon from the media/icon/ folder if applicable (e.g., ![Python](media/icon/python.png) ).
  • Checked spelling and grammar.
  • Removed trailing whitespace and periods.
  • Confirm the dash – is not a minus -.
  • Used title-casing (AP style) for project name.

Checklist for new software projects:

  • Link the code repository rather than the website/documentation
  • Installation instructions present
  • Documentation looks great
  • Examples or Tutorials to follow
  • Tests and Travis CI running

Checklist for new Data Repositories, Tutorials and Cheat Sheets, and Miscellaneous:

  • Easily accessible
  • Comprehensive and widely appealing

Add https://github.com/deepfield-team/DeepField to the list of reservoir engineering tools
@JustinGOSSES
Copy link
Contributor

JustinGOSSES commented Nov 14, 2024

Interesting project. API is documented well but would benefit from a "getting started" or "tutorial" page that runs through using steps of how to use Deep Field with one of the open data models I see are included. This would help people who aren't already deep into the code figure out how to use it.

Additionally, you might consider adding a CONTRIBUTING.md to make clear whether this project accepts contributions from outside the core group and how best to do that. https://github.com/deepfield-team/DeepField/community

There is an open data folder but no mention of open source licenses associated with the data that I saw. I googled one of them dataset and it seems providing it to others in this manner may not be in line with the license: http://www.ipt.ntnu.no/~norne/wiki1/doku.php . & https://github.com/deepfield-team/DeepField/tree/main/open_data/norne . Definitely need to clearly explain what licenses and copyright apply to any included datasets if you are going to package them in your repository. . If some of the models do not have a clear open source license, you might consider simply providing a link to the source such that others can make their own decision, but the model is not being distributed through your repository.

@DeepFieldAdmin
Copy link
Contributor Author

Hi, @JustinGOSSES! Thanks for the good suggestions. We added "Quick start" section to the documentation, added CONTRIBUTING.md, and described terms of use of the models provided in the open_data directory. Is everything fine now to complete the pull request?

@JustinGOSSES JustinGOSSES merged commit b6c0bd6 into softwareunderground:main Nov 26, 2024
1 check failed
@JustinGOSSES
Copy link
Contributor

JustinGOSSES commented Nov 26, 2024

Thanks @DeepFieldAdmin , great improvements! Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants