peterdudfield jcamier commited on
Commit
acd15bc
·
verified ·
1 Parent(s): 1c63f5e

Create README.md (#2)

Browse files

- Create README.md (ab825c0f867cff4512955e2faeb28fc7bdc8d792)


Co-authored-by: Jacques Camier <jcamier@users.noreply.huggingface.co>

Files changed (1) hide show
  1. README.md +71 -0
README.md ADDED
@@ -0,0 +1,71 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ datasets:
3
+ - met-office-uk-deterministic-zarr
4
+ tags:
5
+ - weather
6
+ - nwp
7
+ - met-office
8
+ - deterministic
9
+ - zarr
10
+ - climate
11
+ - solar
12
+ license: cc-by-4.0
13
+ annotations_creators:
14
+ - expert-generated
15
+ language_creators:
16
+ - other
17
+ multilinguality:
18
+ - monolingual
19
+ size_categories:
20
+ - 10K<n<100K
21
+ source_datasets:
22
+ - original
23
+ task_categories:
24
+ - time-series-forecasting
25
+ task_ids:
26
+ - multivariate-time-series-forecasting
27
+ configs:
28
+ - config_name: met-office-uk-deterministic-zarr
29
+ name: met-office-uk-deterministic-zarr
30
+ splits: []
31
+ description: This dataset contains Zarr files uploaded as TAR archives.
32
+ ---
33
+
34
+ ![CC-BY-4.0](https://img.shields.io/badge/license-CC--BY--4.0-blue)
35
+
36
+ # Met Office UK Deterministic Dataset (Zarr Format)
37
+
38
+ ## Description
39
+ This dataset is a **subset** of the [Met Office UK Deterministic Dataset](https://registry.opendata.aws/met-office-uk-deterministic/), converted from the original **NetCDF format** into **Zarr format** for modern data analysis. The Zarr files are packaged as **tar archives** for efficient storage and transfer.
40
+
41
+ The subset focuses on specific variables and configurations, which are detailed in the `met_office_uk_data_config.yaml` file included in this repository. Researchers and developers can use this subset for applications in climate science, weather forecasting, and renewable energy modeling.
42
+
43
+ ## Usage
44
+ This dataset is provided under the **Creative Commons Attribution 4.0 International License (CC-BY-4.0)**. When using this dataset, you must provide proper attribution to the Met Office as outlined below.
45
+
46
+ ## Attribution
47
+ This dataset is derived from the [Met Office UK Deterministic Dataset](https://registry.opendata.aws/met-office-uk-deterministic/), which is British Crown copyright and provided by the Met Office under the terms of the [UK Open Government License (OGL)](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
48
+
49
+ - **Original Source**: [Met Office UK Deterministic Dataset on AWS](https://registry.opendata.aws/met-office-uk-deterministic/)
50
+ - **Copyright**: British Crown copyright © Met Office
51
+
52
+ ## Details
53
+ ### Zarr Format and Tar Archives
54
+ - **Format**: The dataset files are in Zarr format, a modern storage format optimized for analytics and machine learning workflows.
55
+ - **Packaging**: Zarr files are stored as `.tar.gz` archives. Each archive corresponds to a specific time interval, such as `2022-12-01-00.tar.gz`.
56
+
57
+ ### Subset Configuration
58
+ - The dataset includes a subset of variables and configurations chosen for targeted use cases.
59
+ - For details on the variables and configurations included in this dataset, please refer to the [`met_office_uk_data_config.yaml`](./met_office_uk_data_config.yaml) file.
60
+
61
+ ## How to Access
62
+ You can download and extract the tar archives using the following Python snippet:
63
+
64
+ ```python
65
+ import tarfile
66
+
67
+ # Example: Extracting a tar.gz archive
68
+ archive_path = "2022-12-01-00.tar.gz"
69
+ with tarfile.open(archive_path, "r:gz") as tar:
70
+ tar.extractall(path="extracted_zarr")
71
+ ```