List of tags - GeoscienceAustralia/dea-notebooks GitHub Wiki
In order for people to easily find notebooks of interest, the final cell in all notebooks should be the Tags cell. This allows us to compile an index page on the Digital Earth Australia User Guide where users can quickly open notebooks associated with a particular tag.
For this to work well, tags need to be consistently formatted and kept to a minimum where possible. For tags, use all lower-case (unless the tag is an acronym), separate words with spaces (unless it is the name of an imported module), and re-use existing tags.
During the rewrite, the examples below should be treated as the existing tags list. Please add any new tags here so others can use them.
The Tags cell
This appears at the bottom of the DEA notebooks template. Note that the raw cell isn't displayed by GitHub, but will appear when working in JupyterLab. It will have the following form:
**Tags**: :index:`sandbox compatible`, :index:`dea_datahandling`, :index:`sentinel 2`, :index:`NDVI`
Example tags
Environments
Review which environments (Sandbox and NCI) your notebook runs on. Add tags to indicate compatibility.
sandbox compatible
NCI compatible
Datasets
Review the parts of your notebook that load data, and add tags only for loaded data.
landsat 8
landsat 5
sentinel 2
WOfS
WOFLs
fractional cover
NIDEM
ITEM
HLTC
DEA scripts
Review the part of your notebook that imports functions from the Scripts
directory.
Add tags for the script files you use.
dea_plotting
dea_datahandling
dea_bandindices
dea_coastaltools
dea_spatialtools
dea_classificationtools
Custom functions
Review the part of your notebook that imports functions from the Scripts
directory.
Add tags for the custom functions you import.
load_ard
rgb
display_map
calculate_indices
Purpose, functionality and analysis
Review the key functionality and analysis in your notebook and write no more than five tags to capture its purpose.
Tags should be one or two words.
Think about what will be most helpful to others and read existing tags to make sure there's no duplication.
It's ok to create a new tag if you can't find an existing one that captures your notebook's purpose.
Note that band indices (e.g. NDVI
) and other official acronyms (e.g. WOfS
, GeoTIFF
, NetCDF
) should be capitalised where appropriate.
animation
beginner
change detection
cloud masking
dask
exporting data
external data
geomedian
GeoTIFF
intertidal
image compositing
machine learning
NDVI
NetCDF
phenology
pixel quality
polygon drill
real world
regression
reprojecting data
shapefile
spatial interpolation
statistics
time series
tide modelling
widgets
waterline extraction