Update README.md
Browse files
README.md
CHANGED
|
@@ -53,11 +53,27 @@ Please note that ID are unique only within each dataset, meaning that well 1 in
|
|
| 53 |
The parameters used in the simulation can be found in the config files, named [dataset-name]_config.zip.
|
| 54 |
The configuration is stored as a dictionary with the keys being the well IDs.
|
| 55 |
|
| 56 |
-
|
| 57 |
-
#### Personal and Sensitive Information
|
| 58 |
|
| 59 |
The datasets do not contain any personal, sensitive, or private data.
|
| 60 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
## Citation [Coming soon]
|
| 62 |
|
| 63 |
We kindly ask that you cite our paper if you use the ManyWells datasets or code in your academic work.
|
|
|
|
| 53 |
The parameters used in the simulation can be found in the config files, named [dataset-name]_config.zip.
|
| 54 |
The configuration is stored as a dictionary with the keys being the well IDs.
|
| 55 |
|
| 56 |
+
### Personal and Sensitive Information
|
|
|
|
| 57 |
|
| 58 |
The datasets do not contain any personal, sensitive, or private data.
|
| 59 |
|
| 60 |
+
## How to use the data?
|
| 61 |
+
|
| 62 |
+
The following snippet shows how to use the HuggingFace datasets package to download the dataset in Python.
|
| 63 |
+
|
| 64 |
+
```
|
| 65 |
+
import datasets
|
| 66 |
+
|
| 67 |
+
# Download 'manywells-sol-1'
|
| 68 |
+
data = datasets.load_dataset("solution-seeker-as/manywells", name='manywells-sol-1')
|
| 69 |
+
|
| 70 |
+
# Cast dataset to a Pandas DataFrame
|
| 71 |
+
df = data['train'].to_pandas()
|
| 72 |
+
|
| 73 |
+
# Print the data
|
| 74 |
+
print(df)
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
## Citation [Coming soon]
|
| 78 |
|
| 79 |
We kindly ask that you cite our paper if you use the ManyWells datasets or code in your academic work.
|