Skip to content

Commit feaa404

Browse files
committed
Address review comments
1 parent c56fc44 commit feaa404

File tree

93 files changed

+109
-109
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+109
-109
lines changed

_quarto.yml

+52-52
Original file line numberDiff line numberDiff line change
@@ -40,84 +40,84 @@ website:
4040
- veda-project/target-use-cases/data-services.qmd
4141
- veda-project/target-use-cases/scientific-computing.qmd
4242
- text: "---"
43-
- section: users-guide/index.qmd
43+
- section: user-guide/index.qmd
4444
contents:
45-
- section: users-guide/content-curation/index.qmd
45+
- section: user-guide/content-curation/index.qmd
4646
contents:
47-
- section: users-guide/content-curation/dataset-ingestion/index.qmd
47+
- section: user-guide/content-curation/dataset-ingestion/index.qmd
4848
contents:
49-
- users-guide/content-curation/dataset-ingestion/file-preparation.qmd
50-
- users-guide/content-curation/dataset-ingestion/catalog-ingestion.qmd
51-
- users-guide/notebooks/veda-operations/generate-cmip6-kerchunk-historical.ipynb
49+
- user-guide/content-curation/dataset-ingestion/file-preparation.qmd
50+
- user-guide/content-curation/dataset-ingestion/catalog-ingestion.qmd
51+
- user-guide/notebooks/veda-operations/generate-cmip6-kerchunk-historical.ipynb
5252
- section: STAC Collection Creation
5353
contents:
54-
- users-guide/content-curation/dataset-ingestion/stac-collection-conventions.qmd
55-
- users-guide/notebooks/veda-operations/stac-collection-creation.ipynb
56-
- users-guide/notebooks/veda-operations/publish-cmip6-kerchunk-stac.ipynb
54+
- user-guide/content-curation/dataset-ingestion/stac-collection-conventions.qmd
55+
- user-guide/notebooks/veda-operations/stac-collection-creation.ipynb
56+
- user-guide/notebooks/veda-operations/publish-cmip6-kerchunk-stac.ipynb
5757
- section: STAC Item Creation
5858
contents:
59-
- users-guide/content-curation/dataset-ingestion/stac-item-conventions.qmd
60-
- users-guide/notebooks/veda-operations/stac-item-creation.ipynb
59+
- user-guide/content-curation/dataset-ingestion/stac-item-conventions.qmd
60+
- user-guide/notebooks/veda-operations/stac-item-creation.ipynb
6161
- section: Boilerplate ingest example
6262
contents:
63-
- users-guide/content-curation/dataset-ingestion/example-template/example-geoglam-ingest.ipynb
64-
- section: users-guide/content-curation/dashboard-configuration/index.qmd
63+
- user-guide/content-curation/dataset-ingestion/example-template/example-geoglam-ingest.ipynb
64+
- section: user-guide/content-curation/dashboard-configuration/index.qmd
6565
contents:
66-
- users-guide/content-curation/dashboard-configuration/dataset-configuration.qmd
67-
- users-guide/content-curation/dashboard-configuration/story-configuration.qmd
68-
- section: users-guide/content-curation/docs-and-notebooks.qmd
66+
- user-guide/content-curation/dashboard-configuration/dataset-configuration.qmd
67+
- user-guide/content-curation/dashboard-configuration/story-configuration.qmd
68+
- section: user-guide/content-curation/docs-and-notebooks.qmd
6969
contents:
70-
- users-guide/notebooks/templates/template-accessing-the-data-directly.ipynb
71-
- users-guide/notebooks/templates/template-using-the-raster-api.ipynb
72-
- section: users-guide/data-services/index.qmd
70+
- user-guide/notebooks/templates/template-accessing-the-data-directly.ipynb
71+
- user-guide/notebooks/templates/template-using-the-raster-api.ipynb
72+
- section: user-guide/data-services/index.qmd
7373
- section: Data Access and Data Management
7474
contents:
75-
- users-guide/data-services/data-store.qmd
76-
- users-guide/data-services/data-ingestion.qmd
77-
- section: users-guide/data-services/apis/index.qmd
75+
- user-guide/data-services/data-store.qmd
76+
- user-guide/data-services/data-ingestion.qmd
77+
- section: user-guide/data-services/apis/index.qmd
7878
contents:
79-
- users-guide/data-services/apis/raster-api.qmd
80-
- users-guide/data-services/apis/stac-api.qmd
81-
- section: users-guide/scientific-computing/index.qmd
79+
- user-guide/data-services/apis/raster-api.qmd
80+
- user-guide/data-services/apis/stac-api.qmd
81+
- section: user-guide/scientific-computing/index.qmd
8282
contents:
83-
- users-guide/scientific-computing/code-server.md
84-
- users-guide/scientific-computing/ssh.md
85-
- users-guide/scientific-computing/github-authentication.qmd
86-
- users-guide/scientific-computing/custom-environments.qmd
87-
- users-guide/scientific-computing/getting-access.qmd
88-
- section: users-guide/notebooks/index.qmd
83+
- user-guide/scientific-computing/code-server.md
84+
- user-guide/scientific-computing/ssh.md
85+
- user-guide/scientific-computing/github-authentication.qmd
86+
- user-guide/scientific-computing/custom-environments.qmd
87+
- user-guide/scientific-computing/getting-access.qmd
88+
- section: user-guide/notebooks/index.qmd
8989
contents:
9090
- section: Quickstarts
9191
contents:
9292
- section: Accessing the Data Directly
9393
contents:
94-
- users-guide/notebooks/quickstarts/list-collections.ipynb
95-
- users-guide/notebooks/quickstarts/open-and-plot.ipynb
96-
- users-guide/notebooks/quickstarts/timeseries-rioxarray-stackstac.ipynb
97-
- users-guide/notebooks/quickstarts/visualize-zarr.ipynb
98-
- users-guide/notebooks/quickstarts/visualize-multiple-times.ipynb
99-
- users-guide/notebooks/quickstarts/downsample-zarr.ipynb
100-
- users-guide/notebooks/quickstarts/download-assets.ipynb
94+
- user-guide/notebooks/quickstarts/list-collections.ipynb
95+
- user-guide/notebooks/quickstarts/open-and-plot.ipynb
96+
- user-guide/notebooks/quickstarts/timeseries-rioxarray-stackstac.ipynb
97+
- user-guide/notebooks/quickstarts/visualize-zarr.ipynb
98+
- user-guide/notebooks/quickstarts/visualize-multiple-times.ipynb
99+
- user-guide/notebooks/quickstarts/downsample-zarr.ipynb
100+
- user-guide/notebooks/quickstarts/download-assets.ipynb
101101
- section: Using the Raster API
102102
contents:
103-
- users-guide/notebooks/quickstarts/no2-map-plot.ipynb
104-
- users-guide/notebooks/quickstarts/timeseries-stac-api.ipynb
105-
- users-guide/notebooks/quickstarts/hls-visualization.ipynb
103+
- user-guide/notebooks/quickstarts/no2-map-plot.ipynb
104+
- user-guide/notebooks/quickstarts/timeseries-stac-api.ipynb
105+
- user-guide/notebooks/quickstarts/hls-visualization.ipynb
106106
- section: Tutorials
107107
contents:
108-
- users-guide/notebooks/tutorials/gif-generation.ipynb
109-
- users-guide/notebooks/tutorials/netcdf-to-cog-cmip6.ipynb
110-
- users-guide/notebooks/tutorials/mapping-fires.ipynb
111-
- users-guide/notebooks/tutorials/stac_ipyleaflet.ipynb
112-
- users-guide/notebooks/tutorials/zonal-statistics-validation.ipynb
108+
- user-guide/notebooks/tutorials/gif-generation.ipynb
109+
- user-guide/notebooks/tutorials/netcdf-to-cog-cmip6.ipynb
110+
- user-guide/notebooks/tutorials/mapping-fires.ipynb
111+
- user-guide/notebooks/tutorials/stac_ipyleaflet.ipynb
112+
- user-guide/notebooks/tutorials/zonal-statistics-validation.ipynb
113113
- section: Datasets
114114
contents:
115-
- users-guide/notebooks/datasets/ocean-npp-timeseries-analysis.ipynb
116-
- users-guide/notebooks/datasets/nceo-biomass-statistics.ipynb
117-
- users-guide/notebooks/datasets/volcano-so2-monitoring.ipynb
118-
- users-guide/notebooks/datasets/air-quality-covid.ipynb
119-
- users-guide/notebooks/datasets/nldas_time_series.ipynb
120-
- users-guide/notebooks/datasets/nldas_compare2_3.ipynb
115+
- user-guide/notebooks/datasets/ocean-npp-timeseries-analysis.ipynb
116+
- user-guide/notebooks/datasets/nceo-biomass-statistics.ipynb
117+
- user-guide/notebooks/datasets/volcano-so2-monitoring.ipynb
118+
- user-guide/notebooks/datasets/air-quality-covid.ipynb
119+
- user-guide/notebooks/datasets/nldas_time_series.ipynb
120+
- user-guide/notebooks/datasets/nldas_compare2_3.ipynb
121121
- text: "---"
122122
- section: open-source-ecosystem/index.qmd
123123
contents:

index.qmd

+7-7
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ These docs help you use the services provided by the NASA VEDA Platform and lear
2121
:::
2222

2323
:::{#secondcol}
24-
### User's Guide
24+
### User Guide
2525

26-
* [Content Curation](/users-guide/content-curation/index.qmd)
26+
* [Content Curation](/user-guide/content-curation/index.qmd)
2727
* [Data Access and Management Services](/veda-project/target-use-cases/data-services.qmd)
28-
* [Usage Examples and Tutorials](/users-guide/notebooks/index.qmd)
29-
* [Scientific Computing](/users-guide/scientific-computing/index.qmd)
28+
* [Usage Examples and Tutorials](/user-guide/notebooks/index.qmd)
29+
* [Scientific Computing](/user-guide/scientific-computing/index.qmd)
3030
* [Service Status](https://nasa-impact.github.io/veda-statuspage/)
3131
:::
3232

@@ -42,10 +42,10 @@ These docs help you use the services provided by the NASA VEDA Platform and lear
4242

4343
## New to VEDA?
4444

45-
To learn from examples, see the [VEDA Example Notebooks](/users-guide/notebooks/index.qmd) - examples of open-source data science using VEDA services.
45+
To learn from examples, see the [VEDA Example Notebooks](/user-guide/notebooks/index.qmd) - examples of open-source data science using VEDA services.
4646

47-
Selected user groups can also get access to a VEDA-provided [JupyterHub service](/users-guide/scientific-computing/index.qmd).
47+
Selected user groups can also get access to a VEDA-provided [JupyterHub service](/user-guide/scientific-computing/index.qmd).
4848

4949
If you are just getting started with open-source geospatial data science (in Python) or want to learn more, you may find the [Collection of External Resources](/open-source-ecosystem/external-resources.qmd) useful.
5050

51-
Want to contribute data, stories, and example code to this site and the [VEDA Dashboard for NASA EarthData](https://www.earthdata.nasa.gov/dashboard/)? Please see the docs on [Content Curation](/users-guide/content-curation/index.qmd).
51+
Want to contribute data, stories, and example code to this site and the [VEDA Dashboard for NASA EarthData](https://www.earthdata.nasa.gov/dashboard/)? Please see the docs on [Content Curation](/user-guide/content-curation/index.qmd).

open-source-ecosystem/index.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: VEDA Open Source Ecosystem
3-
subtitle: Proliferating open standards for science data platforms
3+
subtitle: Promoting open standards for science data platforms
44
---
55

66
## The Ecosystem

users-guide/content-curation/dashboard-configuration/dataset-configuration.qmd user-guide/content-curation/dashboard-configuration/dataset-configuration.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Dataset Configuration"
33
subtitle: "Configuring your VEDA Dashboard to show a Dataset already available in VEDA Data Services"
44
---
55

6-
Once a dataset is available in your VEDA STAC through VEDA Data Services (following the steps in the [Dataset Ingestion docs](https://docs.openveda.cloud/users-guide/content-curation/dataset-ingestion/)), you will need to configure the Dashboard.
6+
Once a dataset is available in your VEDA STAC through VEDA Data Services (following the steps in the [Dataset Ingestion docs](https://docs.openveda.cloud/user-guide/content-curation/dataset-ingestion/)), you will need to configure the Dashboard.
77

88
Please note that the VEDA Dashboard relies on its own set of metadata about datasets. No information from STAC is loaded initially, so some metadata may require copying information from the STAC records, such as title, description, and dataset providers.
99

users-guide/content-curation/dataset-ingestion/index.qmd user-guide/content-curation/dataset-ingestion/index.qmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,5 @@ Stuck on how to develop compliant metadata records for your dataset?
3636

3737
Checkout the following notebooks and resources to help provide you with the STAC metadata required to [create the dataset definitions needed for catalog ingestion](https://nasa-impact.github.io/veda-docs/content-curation/dataset-ingestion/catalog-ingestion.html).
3838

39-
- **How to create STAC Collections**: see this [example notebook](/users-guide/notebooks/veda-operations/stac-collection-creation.html) and related STAC [conventions](./stac-collection-conventions.qmd)
40-
- **How to create STAC Items**: see this [example notebook](/users-guide/notebooks/veda-operations/stac-item-creation.html) and [conventions](./stac-item-conventions.qmd).
39+
- **How to create STAC Collections**: see this [example notebook](/user-guide/notebooks/veda-operations/stac-collection-creation.html) and related STAC [conventions](./stac-collection-conventions.qmd)
40+
- **How to create STAC Items**: see this [example notebook](/user-guide/notebooks/veda-operations/stac-item-creation.html) and [conventions](./stac-item-conventions.qmd).

users-guide/content-curation/docs-and-notebooks.qmd user-guide/content-curation/docs-and-notebooks.qmd

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Please note that this documentation site is rendered using [Quarto](https://quar
1616

1717
There are two template notebooks in this section that you can use as a starting place. Alternatively you can pull specific cells from that notebook into your own.
1818

19-
* [Using the raster API: `template-using-the-raster-api.ipynb`](/users-guide/notebooks/templates/template-using-the-raster-api.ipynb)
19+
* [Using the raster API: `template-using-the-raster-api.ipynb`](/user-guide/notebooks/templates/template-using-the-raster-api.ipynb)
2020

21-
* [Accessing the data directly: `template-accessing-the-data-directly.ipynb`](/users-guide/notebooks/templates/template-accessing-the-data-directly.ipynb)
21+
* [Accessing the data directly: `template-accessing-the-data-directly.ipynb`](/user-guide/notebooks/templates/template-accessing-the-data-directly.ipynb)
2222

2323

2424
### Style
@@ -67,7 +67,7 @@ Something like: public.ecr.aws/nasa-veda/pangeo-notebook:60b023fba2ca5f9e19d285c
6767

6868
To give the notebooks a standard look and feel we typically include the following sections:
6969

70-
- **Run this Notebook**: The section explains how to run the notebook locally, on [VEDA JupyterHub](https://docs.openveda.cloud/users-guide/scientific-computing/), on [VEDA Trial Hub](https://binder.openveda.cloud/), or on the public [MyBinder](https://mybinder.org/). There are several examples of what this section can look like in the template notebooks.
70+
- **Run this Notebook**: The section explains how to run the notebook locally, on [VEDA JupyterHub](https://docs.openveda.cloud/user-guide/scientific-computing/), on [VEDA Trial Hub](https://binder.openveda.cloud/), or on the public [MyBinder](https://mybinder.org/). There are several examples of what this section can look like in the template notebooks.
7171
- **Approach**: List a few steps that outline the approach you be taking in this notebook.
7272
- **About the data**: Optional description of the dataset
7373
- **Declare your collection of interest**: This section reiterates how you can discover which collections are available. You can copy the example of this section from one of the template notebooks.
@@ -104,7 +104,7 @@ To present consistent best practices, we always access data via the STAC API.
104104

105105
### Generate "Launch in VEDA JupyterHub" link
106106

107-
We use [`nbgitpuller`](https://hub.jupyter.org/nbgitpuller/) links to open the VEDA JupyterHub with a particular notebook pulled in. These links have the form: `https://hub.openveda.cloud/hub/user-redirect/git-pull?repo=https://github.com/NASA-IMPACT/veda-docs&urlpath=lab/tree/veda-docs/users-guide/notebooks/quickstarts/open-and-plot.ipynb&branch=main`
107+
We use [`nbgitpuller`](https://hub.jupyter.org/nbgitpuller/) links to open the VEDA JupyterHub with a particular notebook pulled in. These links have the form: `https://hub.openveda.cloud/hub/user-redirect/git-pull?repo=https://github.com/NASA-IMPACT/veda-docs&urlpath=lab/tree/veda-docs/user-guide/notebooks/quickstarts/open-and-plot.ipynb&branch=main`
108108

109109
If you are writing a notebook and want to share it with others you can generate your own `nbgitpuller` link using this
110110
[link generator](https://hub.jupyter.org/nbgitpuller/link?hub=https://hub.openveda.cloud&repo=https://github.com/NASA-impact/veda-docs&branch=main&app=jupyterlab).
File renamed without changes.

users-guide/data-services/apis/index.qmd user-guide/data-services/apis/index.qmd

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ VEDA tilers are being upgraded to titiler-pgstac v1 which better aligns with the
3737
* STAC API (metadata): [staging.openveda.cloud/api/stac/docs](https://staging.openveda.cloud/api/stac/docs)
3838
* List collections: [staging.openveda.cloud/api/stac/collections](https://staging.openveda.cloud/api/stac/collections)
3939
* Raster API (map tiles and timeseries): [staging.openveda.cloud/api/raster/docs](https://staging.openveda.cloud/api/raster/docs)
40-
* Features API (vector data): [firenrt.delta-backend.com](https://firenrt.delta-backend.com) - see also the [usage tutorial](../users-guide/notebooks/tutorials/mapping-fires.html)
40+
* Features API (vector data): [firenrt.delta-backend.com](https://firenrt.delta-backend.com) - see also the [usage tutorial](../user-guide/notebooks/tutorials/mapping-fires.html)
4141
* Workflows API (request airflow ingestions): [staging.openveda.cloud/api/workflows/docs](https://staging.openveda.cloud/api/workflows/docs)
4242
* STAC viewer (experimental): [staging.openveda.cloud/api/stac/index.html](https://staging.openveda.cloud/api/stac/index.html)
4343

@@ -63,8 +63,8 @@ That is because, unfortunately, neither XYZ nor WMTS have time series capabiliti
6363

6464
You can see how to retrieve time steps and tile layer URLs from these tutorial Python notebooks (mostly REST API calls):
6565

66-
1. [Using /stac/tilejson.json with STAC collection and item IDs](/users-guide/notebooks/datasets/ocean-npp-timeseries-analysis.html#visualizing-the-raster-imagery)
67-
2. [Creating layers from filters and mosaics (advanced)](/users-guide/notebooks/quickstarts/hls-visualization.html)
66+
1. [Using /stac/tilejson.json with STAC collection and item IDs](/user-guide/notebooks/datasets/ocean-npp-timeseries-analysis.html#visualizing-the-raster-imagery)
67+
2. [Creating layers from filters and mosaics (advanced)](/user-guide/notebooks/quickstarts/hls-visualization.html)
6868

6969
It comes down to querying for STAC items (timesteps) and then asking the Raster API for `tilejson.json` specifications for the items you are interested in.
7070

users-guide/data-services/data-ingestion.qmd user-guide/data-services/data-ingestion.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ VEDA's data ingestion services are designed to handle and manage the flow of dat
1515

1616
2. **Ingest APIs**
1717
- The Ingest API facilitates data ingestion from multiple sources and manages the data flow into VEDA's system. This API is included in [veda-backend](https://github.com/NASA-IMPACT/veda-backend)
18-
- To learn how to interact with these APIs as a user, consult the [Dataset Ingestion Guide](/users-guide/content-curation/dataset-ingestion/index.qmd).
18+
- To learn how to interact with these APIs as a user, consult the [Dataset Ingestion Guide](/user-guide/content-curation/dataset-ingestion/index.qmd).
1919

users-guide/data-services/data-store.qmd user-guide/data-services/data-store.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ The main public interface is the [STAC browser](https://openveda.cloud/?.languag
2424

2525
The process of data ingestion into the VEDA Data Store is under active development.
2626

27-
Please see our docs on [dataset ingestion](/users-guide/content-curation/dataset-ingestion/index.qmd).
27+
Please see our docs on [dataset ingestion](/user-guide/content-curation/dataset-ingestion/index.qmd).
File renamed without changes.

users-guide/index.qmd user-guide/index.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Use's Guide
2+
title: User Guide
33
subtitle: Resources for users and content contributors
44
---
55

0 commit comments

Comments
 (0)