This is a Git repository for developing data articles (more than one!) about the 3W Dataset, which is a part of the 3W Project, in an open and collaborative way with the global community.
The purpose of this work is to provide high-quality data articles that facilitate a comprehensive understanding of the 3W Dataset and that can be used and referenced in commercial, academic and scientific projects supported by the 3W Dataset.
The DATA ARTICLE being developed relates to the 3W Dataset 2.0.0.
The 3W Dataset 1.0.0 is described in the article A realistic and public dataset with rare undesirable real events in oil wells published in the Journal of Petroleum Science and Engineering in mid-2019.
Future versions of the 3W Dataset will require the development of other data articles.
- Anyone can suggest contributions relating to any aspect of this work, including this README file, these rules, and any other file in this Git repository;
- Ricardo Vargas, as the leader of this work and owner of this Git repository, can accept or reject any suggestion and will therefore be the first author of the DATA ARTICLE when it gets published;
- All contributions should be only made via Pull Requests and/or via Discussions in this Git repository;
- Only those whose Pull Requests are accepted and/or contributions to the Discussions are considered relevant can be considered co-authors of the DATA ARTICLE;
- By proposing contributions, the potential contributor declares full agreement with all these rules;
- All contributions from all contributors should be kept summarized in CONTRIBUTORS AND CONTRIBUTIONS;
- The list of EXAMPLES OF PUBLISHED DATA ARTICLES can be consulted for inspiration throughout this work;
- This work will be done in stages and all participants must take into account the STAGES AND DEADLINES;
- The existence of this Git repository and this work can be publicized at any time, in any way, and by anyone.
Any question about this work can be asked, viewed and/or commented any time by anyone in the Q&A.
For anyone to contribute to this work, there are requirements and possibilities which are listed below.
- Good knowledge about the 3W Dataset 2.0.0;
- Overviews can be found here;
- The dataset.ini, as the 3W Dataset's main configuration file, is a very important resource for understanding the 3W Dataset 2.0.0.
- Good knowledge about data articles (which are quite different from research articles);
- Here are some good materials on this subject:
- Acceptance of all above-mentioned rules.
- Click on the Watch button to be notified of progress throughout this work.
- Promote this work on social networks. With more contributors, we will develop higher quality data articles;
- Join in the Discussions:
- Keep an eye on the Announcements;
- Be active in the General discussions;
- Propose and comment Ideas;
- Propose and participate in the Polls.
- Submit Pull Requests with suggestions regarding any file in this Git repository. Please, use only the
main
branch.
IMPORTANT: different contributions will be needed at different stages of the work according to the STAGES AND DEADLINES.