Update nonlocal_parameterization/README.md

nonlocal_parameterization/README.md

@@ -1,143 +1,19 @@
----
-# For reference on dataset card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
-# Doc / guide: https://huggingface.co/docs/hub/datasets-cards
-{}
----
+% Data format description for the nonlocal gravity wave parameterization dataset
+% Contact: https://github.com/amangupta2 or amangupta2@gmail.com
+% Date: 29 August 2024
 
-# Dataset Card for Dataset Name
+The nonlocal parameterization dataset contains inputs features for the background atmospheric field and output labels for the subgrid-scale fluxes for those fields computed using ECMWF's ERA5. The full dataset comprises atmospheric state and fluxes computed for the years 2010, 2012, 2014, and 2015. Out of the 48 months computed, 4 are provided here for testing.
 
-<!-- Provide a quick summary of the dataset. -->
+Each netCDF file contains:
+- dimensional variables: 64 latitudes (LAT) and 128 longitudes (LON)
+- features: input features, i.e., the background state of the atmosphere, with dimension TIME x IDIM x LAT x LON
+- output: output fluxes, i.e., the momentum fluxes carried by the gravity waves, computed using Helmholtz Decomposition, for the background state, with dimension TIME x ODIM x LAT x LON
 
-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).
+IDIM = 369
+ODIM = 244
 
-## Dataset Details
+The input (features) has a vertical dimension (IDIM) equal to 369 because it is created by concatenating the latitude, longitude, surface elevation zonal winds, meridional winds, and potential temperature along the vertical dimension. For example, the winds and potential temperature were computed on 122 pressure levels from ERA5. Thus, IDIM index 0 corresponds to latitude, 1 corresponds to longitude, 2 corresponds to surface elevation for the given latitude and longitude, 3 to 124 correspond to zonal wind, 125 to 246 correspond to meridional wind, 247 to 368 correspond to potential temperature.
 
-### Dataset Description
+Likewise, the output has a vertical dimension (ODIM) equal to 244 because it is created by concatenating the zonal flux of vertical momentum and the meridional flux of vertical momentum along the vertical dimension. ODIM 0 to 121 correspond to the zonal flux component and ODIM 122 to 243 correspond to the meridional flux component.
 
-<!-- Provide a longer summary of what this dataset is. -->
-
-
-
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-
-### Dataset Sources [optional]
-
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [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]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
-
-## 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. -->
-
-[More Information Needed]
-
-## Dataset Creation
-
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
-### 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?
-
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### Personal and Sensitive Information
-
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Dataset Card Authors [optional]
-
-[More Information Needed]
-
-## Dataset Card Contact
-
-[More Information Needed]
+Therefore, the neural network would predict the zonal and meridional momentum fluxes on 122 pressure level each, using the latitude, longitude, and surface elevation, and the zonal wind, meridional wind, and potential temperature on 122 pressure levels.