-
Notifications
You must be signed in to change notification settings - Fork 3
"Collections and Granules" page with some "Glossary" things #34
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.
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
Open
saberbrasher
wants to merge
5
commits into
nsidc:main
Choose a base branch
from
saberbrasher:collections-granules-glossary
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7f965a2
Create collections and granules page, create a glossary quarto page, …
c68b236
Added section headers back, but hidden.
ac6c359
Update reference-guides/collections-granules.qmd
saberbrasher cbd1532
Made revisions based on Andy's feedback.
98ada38
Change granule description.
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,3 +5,5 @@ example_data/ | |
| *.nc | ||
| _freeze | ||
| .venv/ | ||
|
|
||
| **/*.quarto_ipynb | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
saberbrasher marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,59 @@ | ||
| # Glossary | ||
| --- | ||
| title: "Glossary" | ||
| format: | ||
| html: | ||
| toc: true | ||
| --- | ||
| #### Filter your search by using the handy bar below! | ||
|
|
||
| <!-- Search bar --> | ||
| <input id="glossary-search" type="text" placeholder="Search terms or definitions..." style="width: 100%; padding: 0.5em; margin-bottom: 1em; font-size: 1em;"> | ||
| <!-- Glossary entries --> | ||
| <details> | ||
| <summary>Coordinate Reference System</summary> | ||
| A coordinate system that has its position, scale, and orientation defined with respect to an object. This is accomplished through a datum. For geospatial data this is usually the Earth. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Coordinate System</summary> | ||
| A set of rules that define how coordinates are assigned to points. Coordinates describing locations on Earth or another object are referenced to a Coordinate Reference System. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Geodetic Coordinate System</summary> | ||
| A coordinate reference system based on a geodetic datum. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Map Projection</summary> | ||
| A coordinate conversion from an ellipsoidal coordinate system to a plane. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Projected Coordinate Reference System</summary> | ||
| A Coordinate Reference System derived from a two dimensional geodetic coordinate reference system by applying a map projection. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Projection Parameters</summary> | ||
| Parameters defining a map projection. | ||
| </details> | ||
|
|
||
| <script> | ||
| const searchInput = document.getElementById("glossary-search"); | ||
| const entries = document.querySelectorAll("details"); | ||
|
|
||
| searchInput.addEventListener("input", () => { | ||
| const filter = searchInput.value.toLowerCase(); | ||
| entries.forEach(entry => { | ||
| const term = entry.querySelector("summary").textContent.toLowerCase(); | ||
| const definition = entry.textContent.toLowerCase(); | ||
| // Show if term or definition matches | ||
| if (term.includes(filter) || definition.includes(filter)) { | ||
| entry.style.display = ""; | ||
| } else { | ||
| entry.style.display = "none"; | ||
| } | ||
| }); | ||
| }); | ||
| </script> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| --- | ||
| title: "Collections & Granules" | ||
| format: | ||
| html: | ||
| toc: true | ||
| code-fold: false | ||
| execute: | ||
| enabled: false | ||
| --- | ||
|
|
||
| NASA Earth science data can feel overwhelming when you're new to it... there are thousands of datasets, millions of files, and many tools for accessing them. A first step in combatting the overhwhelm is better understanding how NASA organizes, and talks about, their data. | ||
saberbrasher marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| --- | ||
|
|
||
| # What Are Collections and Granules? | ||
|
|
||
| ## 📘 Collections | ||
|
|
||
| A **collection** is NASA’s version of a “dataset family.” | ||
| Every collection groups together many related files that share common features, such as: | ||
|
|
||
| - The same satellite or instrument | ||
| - The same science product type | ||
| - The same processing level | ||
| - A consistent file structure | ||
|
|
||
| A collection is the *group* that defines **what** the dataset is. | ||
|
|
||
| **Examples:** | ||
|
|
||
| - *SMAP L4 Global 3-hourly 9 km EASE-Grid Surface and Root Zone Soil Moisture Geophysical Data V008* | ||
| - *ATLAS/ICESat-2 L3A Land and Vegetation Height V007* | ||
|
|
||
| Collection metadata includes at least the following: | ||
|
|
||
| - Product description | ||
| - Spatial & temporal coverage | ||
| - Data provider | ||
| - Variables | ||
| - Version | ||
|
|
||
| ## 📄 Granules | ||
|
|
||
| A **granule** is a single file within a collection. | ||
saberbrasher marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Each granule usually represents a **single point in space and/or time**. For example, one granule could represent: | ||
|
|
||
| - One SMAP orbit pass, or | ||
| - One ICESat-2 ground track | ||
saberbrasher marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Granules also have their own metadata, such as: | ||
|
|
||
| - Timestamps | ||
| - A spatial bounding box | ||
| - File size | ||
| - Variables included, etc. | ||
|
|
||
| Granules are what you actually **download and analyze**. It is common to need MANY granules for a specific research objective! | ||
|
|
||
| --- | ||
|
|
||
| # NASA’s Metadata Backbone: CMR | ||
|
|
||
| NASA stores all metadata (for collections *and* granules) in a system called the **Common Metadata Repository (CMR)**. CMR serves as NASA's search index, metadata database, and API system for data tools. | ||
saberbrasher marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| CMR powers: | ||
|
|
||
| - Earthdata Search | ||
| - DAAC search portals | ||
| - APIs for programmatic discovery | ||
| - Cloud-native data access workflows | ||
saberbrasher marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| CMR metadata is stored using the **Unified Metadata Model (UMM)**: | ||
|
|
||
| - **UMM-C** → Collection metadata | ||
| - **UMM-G** → Granule metadata | ||
| - **UMM-Var** → Variables | ||
| - **UMM-Svc** → Services | ||
| - **UMM-T** → Tools | ||
|
|
||
| Using the UMM allows CMR to host its metadata records in several supported native formats, with translation services available between formats. | ||
|
|
||
| # Collection & Granule Names | ||
|
|
||
| NASA uses structured naming so files can be indexed, searched, and recognized by automated workflows. | ||
|
|
||
| ### 📘 Collection Names | ||
saberbrasher marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| A collection has: | ||
|
|
||
| ##### 1. **Long Name (Human-Readable)** | ||
| Example: | ||
| *SMAP L4 Global 3-hourly 9 km EASE-Grid Surface and Root Zone Soil Moisture Geophysical Data V008* | ||
|
|
||
| ##### 2. **Short Name (Machine-Friendly)** | ||
| Example: | ||
| *SPL4SMGP* | ||
|
|
||
| ##### 3. **Version** | ||
| Example: | ||
| *008* | ||
|
|
||
| The combination **short name + version** uniquely identifies a dataset within CMR. | ||
|
|
||
| ### 📄 Granule Names | ||
|
|
||
| Granule names can get pretty lengthy and will include some important information about the data collection they are contained within, as well as specifics about that granule in particulat. For example, most products will have a naming "formula" that includes the following: | ||
saberbrasher marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - Product short name | ||
| - Date and optional time | ||
| - Version | ||
| - File type | ||
|
|
||
| ::: {.callout-note} | ||
| Not all naming structures are the same for all data products! If there is a User Guide (found on the data set landing page, NSIDC0803's linked [here](https://nsidc.org/data/nsidc-0803/versions/2)) for that product, it will explain it all for you! | ||
| ::: | ||
|
|
||
| #### Here is an example granule from AMSR2 Daily Polar Gridded Sea Ice Concentrations, Version 2: | ||
| `NSIDC0803_SEAICE_AMSR2_S_20240105_v2.0.nc` | ||
|
|
||
| ##### Naming Breakdown | ||
|
|
||
| | Component | Example | Meaning | | ||
| |----------|---------|---------| | ||
| | Short name | `NSIDC0803` | AMSR2 Daily Polar Gridded Sea Ice Concentrations Product | | ||
| | Information | `SEAICE_AMSR2_S` | Variable, satellite, and hemisphere | | ||
| | Date/time | `20240105` | YYYYMMDD format | | ||
| | Version | `v2.0` | Collection version | | ||
| | File type | `.nc` | NetCDF format | | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.