Skip to content

Commit

Permalink
fix typos and errors
Browse files Browse the repository at this point in the history
  • Loading branch information
Andy Barrett committed Aug 19, 2024
1 parent 2beb458 commit fce94d9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@
"alt: A N-Dimensional data structure for temperature and precipitation\n",
"align: center\n",
"name: n-dimensional\n",
"background: white\n",
"---\n",
"A cartoon of a NetCDF-style N-dimensional data structure containing ($time$,$x$,$y$) data-cubes of air temperature and precipitation, and latitude and longitude coordinate variables. The named dimensions in the file are shown as orthogonal axes to the right of the variables.\n",
"Source: [xarray-dev](https://xarray.dev/)\n",
Expand Down
20 changes: 15 additions & 5 deletions book/tutorials/open-science/open_science_lesson.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2324,9 +2324,15 @@
"\n",
"`long_name` and `standard_name` attributes are not required but use of at least one of these is recommended. `long_name` provides a description of the variable. that can be used for labelling plots For the `sic` variable, an appropriate `long_name` is `\"sea ice concentration\"`.\n",
"\n",
"The purpose of `standard_name` is to provide an unambiguous description of the variable and facilitate interoperability. `standard_name` attributes should be from a [controlled vocabulary]() defined as part of CF-Convention [Standard Name Table](https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html). For sea ice concentration, the `standard_name` is `sea_ice_area_fraction`. `standard_names` should be lower case and use `_` instead of spaces. The expected units are also provided in the [Standard Name Table](https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html). For more information on standard names see [Section 3.3 of CF Convention 1.11](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#standard-name)\n",
"\n",
"`sic_mask` - add explanation of mask from standard name table"
"The purpose of `standard_name` is to provide an unambiguous description of the variable and facilitate interoperability. `standard_name` attributes should be from a [controlled vocabulary]() defined as part of CF-Convention [Standard Name Table](https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html). For sea ice concentration, the `standard_name` is `sea_ice_area_fraction`. `standard_names` should be lower case and use `_` instead of spaces. The expected units are also provided in the [Standard Name Table](https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html). For more information on standard names see [Section 3.3 of CF Convention 1.11](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#standard-name)"
]
},
{
"cell_type": "markdown",
"id": "bf11f3d8-c126-4512-b856-b1e25db43d9d",
"metadata": {},
"source": [
"### Add attributes for data variables"
]
},
{
Expand Down Expand Up @@ -2358,6 +2364,8 @@
"id": "ffd9b1b6-b4f6-4217-a89f-085a241c711c",
"metadata": {},
"source": [
"### Add attributes for coordinate variables\n",
"\n",
"Coordinate variables also need attributes. If a dataset has geographic spatial coordinates, i.e. _Latitude_ and _Longitude_, only `units`, `long_name` and `standard_name` attributes are necessary. For example:\n",
"\n",
"```\n",
Expand Down Expand Up @@ -2405,6 +2413,8 @@
"id": "3baf1fbd-2dfe-4b5b-ab2d-a29eb7bd98ff",
"metadata": {},
"source": [
"#### Time is precious!\n",
"\n",
"The other coordinate that needs attributes is `time`. Times are stored in NetCDF as increments from a start date or time. The `units` attribute is required to define the time unit for the increment and the datetime that increments start from. An example is\n",
"\n",
"`days since 1900-01-01 00:00:00`\n",
Expand Down Expand Up @@ -2937,7 +2947,7 @@
"id": "051ed58e-6f35-4108-a2e9-8b8b1dcb5fd2",
"metadata": {},
"source": [
"### Global Attributes\n",
"### Add Global Attributes\n",
"\n",
"While not required by CF Conventions, it is helpful to provide the title of the dataset, the source, any processing history and a reference for the dataset. This can increase _reusability_. Because this information does not apply to any one variable but the dataset as a whole, they are assigned as _global attributes_.\n",
"\n",
Expand Down Expand Up @@ -3465,7 +3475,7 @@
"id": "84506db8-161a-4e0c-a14e-c33edfe48051",
"metadata": {},
"source": [
"### Packaging the data for use\n",
"## Packaging the data for use\n",
"\n",
"We now have a dataset and variables that have coordinates that are related to Earth by a Coordinate Reference System (CRS) in the `grid_mapping_name`. The variables have attributes so that we know what each variable is, how it should be interpretted and what the units are. We have added some dataset information to help uses understand where the data can from and how it was processing in the global attributes.\n",
"\n",
Expand Down

0 comments on commit fce94d9

Please sign in to comment.