Update README.md

README.md

@@ -16,81 +16,44 @@ pretty_name: ManyWells simulated multiphase flow data
 size_categories:
 - 1M<n<10M
 ---
-# Dataset Card for ManyWells
+# ManyWells: simulation of multiphase flow in thousands of wells
 
-<!-- Provide a quick summary of the dataset. -->
+The ManyWells datasets contain simulations of multiphase (gas, oil, water) flow in thousands of wells. 
 
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
-
-## Dataset Details
-
-### Dataset Description
-
-<!-- Provide a longer summary of what this dataset is. -->
+The datasets were created and shared by Solution Seeker AS and the Norwegian University of Science and Technology to support research on data-driven methodologies and industrial applications of machine learning and AI.
 
+## Dataset details
 - **Curated and shared by:** [Solution Seeker AS](https://www.solutionseeker.no)
 - **License:** Creative Commons BY-NC 4.0
-
-### Dataset Sources [optional]
-
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [Official GitHub repository of the ManyWells project](https://github.com/solution-seeker-as/manywells)
-- **Paper [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the dataset is intended to be used. -->
-
-### Direct Use
-
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
-
+- **Code repository:** [Official GitHub repository of the ManyWells project](https://github.com/solution-seeker-as/manywells)
+- **Paper:** [Coming soon]
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+There are currently three datasets for three different operating conditions:
+- manywells-sol-1: simulations with stationary boundary conditions and open-loop control (no feedback)
+- manywells-nsol-1: simulations with non-stationary boundary conditions and open-loop control (no feedback)
+- manywells-nscl-1: simulations with non-stationary boundary conditions and closed-loop control (with feedback)
 
-[More Information Needed]
+Each dataset has one million data points from 2000 vertical wells (500 data points per well). 
+The datasets include a feature called "ID", which uniquely identifies a wells. 
+Please note that ID are unique only within each dataset, meaning that well 1 in dataset A is different from well 1 in dataset B.
 
-## Dataset Creation
-
-### Curation Rationale
-
-The ManyWells datasets were created to facilitate research on machine learning and other data-driven methodologies on petroleum production use cases.
-
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
-#### Data Collection and Processing
-
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
-
-#### Who are the source data producers?
-
-The ManyWells datasets were created by Norwegian private company Solution Seeker AS in cooperation with the Norwegian University of Science and Technology.
+The parameters used in the simulation can be found in the config files, named [dataset-name]_config.zip. 
+The configuration is stored as a dictionary with the keys being the well IDs.
 
 
 #### Personal and Sensitive Information
 
 The dataset does not contain any personal, sensitive, or private data.
 
-## Citation [optional]
+## Citation [Coming soon]
 
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+We kindly ask that you cite our paper if you use the ManyWells datasets or code in your academic work.
 
 **BibTeX:**
 
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
+[Coming soon]
 
 
 ## Dataset Card Contact