Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TRT-290 - Augment documentation notebook regarding required variables. #35

Merged
merged 2 commits into from
Aug 27, 2024
Merged

TRT-290 - Augment documentation notebook regarding required variables. #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b8dae4
TRT-290 - Augment documentation notebook regarding required variables.
owenlittlejohns Aug 26, 2024
b50c3da
TRT-290 - Minor wording tweaks.
owenlittlejohns Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/earthdata-varinfo.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,17 @@
"source": [
"In the output above, `/Grid/precipiationCal` has three dimensions: `/Grid/time`, `/Grid/lat` and `/Grid/lon`. These dimension variables also refer to their respective [bounds variables](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.10/cf-conventions.html#cell-boundaries). Because `get_required_variables` is recursive, the bounds attributes are also considered required variables for `/Grid/precipitationCal`.\n",
"\n",
"When a `VarInfoFromDmr` or `VarInfoFromNetCDF4` object is instantiated, specific CF Convention metadata attributes of each variable are checked for references to other variables. These references are then fully qualified to absolute paths for later use by methods such as `VarInfoFromNetCDF4.get_required_variables`. The metadata attributes expected to contain references to other variables, per the CF Conventions, include:\n",
"\n",
"* [ancillary_variables](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#ancillary-data)\n",
"* [coordinates](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#coordinate-types), see also [here](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#coordinate-system).\n",
"* [grid_mapping](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#grid-mappings-and-projections)\n",
"* [bounds](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#cell-boundaries)\n",
"* [cell_measures](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#cell-measures)\n",
"* [geometry, interior_ring, node_coordinates, node_count, nodes and part_node_count](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#geometries)\n",
"\n",
"It is possible that metadata attributes may be absent from a variable or contain incorrect metadata. In these cases, these attributes can be added or overriden using a configuration file specified by the `config_file` kwarg during instantiation of either a `VarInfoFromNetCDF4` or `VarInfoFromDmr` object.\n",
"\n",
"### More variable relationship examples:\n",
"\n",
"Users can supply a set of variable full paths to the following functions to retrieve only the spatial or temporal dimensions for a given variable (methods below are present on both the `VarInfoFromNetCDF4` and `VarInfoFromDMR` classes:\n",
Expand Down
Loading