Skip to content

Commit 33fddd8

Browse files
authored
Contributing updates (#127)
* Make contributing docs clearer * Add information about running with custom image
1 parent e30acc8 commit 33fddd8

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ Learn more about this project [https://www.earthdata.nasa.gov/esds/veda](https:/
55

66
## Contributing
77

8-
This site is rendered using [Quarto](https://quarto.org/), which comes with various developer/contributor resources.
9-
10-
The gist: download the package from their [Get Started](https://quarto.org/docs/get-started/) page and `quarto build` locally to preview your changes
11-
and open a Pull Request on this repository.
12-
8+
For info on contributing documentation to VEDA see: https://nasa-impact.github.io/veda-docs/contributing/
139

1410
## License
1511

contributing/docs-and-notebooks.qmd

+13-5
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,15 @@ execute:
4040
---
4141
```
4242

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.
50+
51+
Something like: public.ecr.aws/nasa-veda/pangeo-notebook:60b023fba2ca5f9e19d285c245987e368e27c0ea626b65777b204cec14b697c7
4452

4553

4654
### Standard sections
@@ -49,18 +57,18 @@ To give the notebooks a standard look and feel we typically include the followin
4957

5058
- **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.
5159
- **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
5361
- **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.
5462

5563
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.
5664

5765

5866
### Using complex geometries
5967

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.
6169

6270

63-
### Recommended librarires
71+
### Recommended libraries
6472

6573
#### Mapping + Visualization
6674

@@ -71,7 +79,7 @@ If you are defining the AOI using a bounding box, you can include it in the text
7179

7280
#### Using STAC for cataloging data
7381

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.
7583

7684
* [pystac](https://pystac.readthedocs.io/): PySTAC is a library for creating SpatioTemporal Asset Catalogs (STAC) in Python 3.
7785
* [pystac-client](https://github.com/stac-utils/pystac-client): A Python client for working with STAC Catalogs and APIs.

0 commit comments

Comments
 (0)