Update README.md

README.md

@@ -33,13 +33,13 @@ configs:
 
 The ManyWells datasets contain simulations of multiphase (gas, oil, water) flow in thousands of wells. The datasets were created and shared by Solution Seeker AS to support research on data-driven methodologies and industrial applications of machine learning and AI.
 
-## Dataset details
+## Details
 - **Curated and shared by:** [Solution Seeker AS](https://www.solutionseeker.no)
 - **License:** Creative Commons BY-NC 4.0
-- **Code repository:** [Official GitHub repository of the ManyWells project](https://github.com/solution-seeker-as/manywells)
+- **Code repository:** [ManyWells GitHub repository](https://github.com/solution-seeker-as/manywells)
 - **Paper:** [Coming soon]
 
-## Dataset Structure
+## Description of datasets
 
 There are currently three datasets for three different operating conditions:
 - **manywells-sol-1**: simulations with stationary boundary conditions and open-loop control (no feedback)
@@ -47,13 +47,58 @@ There are currently three datasets for three different operating conditions:
 - **manywells-nscl-1**: simulations with non-stationary boundary conditions and closed-loop control (with feedback)
 
 Each dataset has one million data points from 2000 vertical wells (500 data points per well). 
+Each data point corresponds to one simulation performed by the simulator  code in the [ManyWells GitHub repository](https://github.com/solution-seeker-as/manywells).
+
 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.
 
 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
+### Dataset features
+
+
+| Feature | Description                                                       |  Unit |
+|:--------|:------------------------------------------------------------------|------:|
+| ID      | Unique well ID                                                    |     - |
+| CHK     | Choke position in \[0, 1\]                                        |     - |
+| PBH     | Pressure bottomhole                                               |   bar |
+| PWH     | Pressure wellhead                                                 |   bar |
+| PDC     | Pressure downstream choke                                         |   bar |
+| TBH     | Temperature bottomhole                                            |     K |
+| TWH     | Temperature wellhead                                              |     K |
+| WGL     | Mass flow rate, lift gas                                          |  kg/s |
+| WGAS    | Mass flow rate, gas excl. lift gas                                |  kg/s |
+| WLIQ    | Mass flow rate, liquid                                            |  kg/s |
+| WOIL    | Mass flow rate, oil                                               |  kg/s |
+| WWAT    | Mass flow rate, water                                             |  kg/s |
+| WTOT    | Mass flow rate, total incl. lift gas                              |  kg/s |
+| QGL     | Volumetric flow rate at standard conditions, lift gas             | Sm³/h |
+| QGAS    | Volumetric flow rate at standard conditions, gas excl. lift gas   | Sm³/h |
+| QLIQ    | Volumetric flow rate at standard conditions, liquid               | Sm³/h |
+| QOIL    | Volumetric flow rate at standard conditions, oil                  | Sm³/h |
+| QWAT    | Volumetric flow rate at standard conditions, water                | Sm³/h |
+| QTOT    | Volumetric flow rate at standard conditions, total incl. lift gas | Sm³/h |
+| FGAS    | Inflow gas mass fraction                                          |     - |
+| FOIL    | Inflow oil mass fraction                                          |     - |
+| FWAT    | Inflow water mass fraction                                        |     - |
+| WEEKS   | Weeks since first data point                                      |    7d |
+| CHOKED  | Boolean indicating if flow is choked                              |     - |
+| FRBH    | Flow regime at bottomhole (represented by string)                 |     - |
+| FRWH    | Flow regime at wellhead (represented by string)                   |     - |
+
+The following relations apply:
+- WLIQ = WOIL + WWAT
+- WTOT = WLIQ + WGAS + WGL
+- QLIQ = QOIL + QWAT
+- QTOT = QLIQ + QGAS + QGL
+
+The flow regime features, FRBH and FRWH, may take on one of the following string values: 
+'bubbly', 'slug-churn', 'annular'. 
+
+The WEEKS feature is only present in non-stationary datasets (manywells-nsol-1 and manywells-nscl-1).
+
+### Personal and sensitive information
 
 The datasets do not contain any personal, sensitive, or private data.
 
@@ -74,7 +119,7 @@ df = data['train'].to_pandas()
 print(df)
 ```
 
-## Citation [Coming soon]
+## Citation [coming soon]
 
 We kindly ask that you cite our paper if you use the ManyWells datasets or code in your academic work.
 
@@ -83,6 +128,6 @@ We kindly ask that you cite our paper if you use the ManyWells datasets or code
 [Coming soon]
 
 
-## Dataset Card Contact
+## Dataset contact
 
 Queries about the dataset can be directed to Bjarne Grimstad (e-mail: [email protected]).