You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: contributing/docs-and-notebooks.qmd
+13-5
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,15 @@ execute:
40
40
---
41
41
```
42
42
43
-
We store evaluted notebooks in this repository. So before you commit your notebook, you should restart your kernel and run all cells in order.
43
+
### Running notebooks
44
+
45
+
We store evaluated notebooks in this repository. So before you commit your notebook, you should restart your kernel and run all cells in order.
46
+
47
+
Normally we run the notebooks on [VEDA JupyterHub](https://hub.openveda.cloud).
48
+
49
+
To run the notebooks with a new image, use the JupyterHub image selection interface and under "Custom Image" type in the address to the public ecr image with the full tag sha.
@@ -49,18 +57,18 @@ To give the notebooks a standard look and feel we typically include the followin
49
57
50
58
-**Run this Notebook**: The section explains how to run the notebook locally, on VEDA JupyterHub or on [mybinder](https://mybinder.org/). There are several examples of what this section can look like in the template notebooks.
51
59
-**Approach**: List a few steps that outline the approach you be taking in this notebook.
52
-
-**About the data**: Optional description of the datatset
60
+
-**About the data**: Optional description of the dataset
53
61
-**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.
54
62
55
63
From then on the standard sections diverge depending on whether the notebook access the data directly or uses the raster API. Check the template notebooks for some ideas of common patterns.
56
64
57
65
58
66
### Using complex geometries
59
67
60
-
If you are defining the AOI using a bounding box, you can include it in the text of the notebook, but for more complex geometries we prefer that the notebook access the geometry directly from a canonical source. You can check the template notebooks for exmples of this. If the complex geometry is not available online the VEDA team can help get it up in a public s3 bucket.
68
+
If you are defining the AOI using a bounding box, you can include it in the text of the notebook, but for more complex geometries we prefer that the notebook access the geometry directly from a canonical source. You can check the template notebooks for examples of this. If the complex geometry is not available online the VEDA team can help get it up in a public s3 bucket.
61
69
62
70
63
-
### Recommended librarires
71
+
### Recommended libraries
64
72
65
73
#### Mapping + Visualization
66
74
@@ -71,7 +79,7 @@ If you are defining the AOI using a bounding box, you can include it in the text
71
79
72
80
#### Using STAC for cataloging data
73
81
74
-
To present consistent best practices, we always access data via the STAC API. Often we use `stackstac` for this.
82
+
To present consistent best practices, we always access data via the STAC API.
75
83
76
84
*[pystac](https://pystac.readthedocs.io/): PySTAC is a library for creating SpatioTemporal Asset Catalogs (STAC) in Python 3.
77
85
*[pystac-client](https://github.com/stac-utils/pystac-client): A Python client for working with STAC Catalogs and APIs.
0 commit comments