Skip to content

Commit

Permalink
[docs] Replace advanced loading section with note; add loading details
Browse files Browse the repository at this point in the history
  • Loading branch information
maawoo committed Nov 27, 2023
1 parent 9be0273 commit de0d4ea
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions docs/content/02_Getting_Started/01_00_Data_Access.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,16 @@ It is a wrapper around various other, product-specific functions and its goal is
to provide a unified and easy-to-use interface for loading data from the SDC.

A lot happens in the background and certain parameters are set to default
values, so that the function can be used with minimal effort. However, it is
also possible to specify additional parameters to customize the data loading
process. See the {ref}`advanced-loading` section for more information.
values, so that the function can be used with minimal effort. Most importantly,
all data products are loaded with the coordinate reference system (CRS)
[EPSG:4326](https://epsg.io/4326) and resolution set to 0.0002°, which
corresponds to approximately 20 x 20 m at the equator.

```{note}
In the future, it will be possible to specify additional parameters to customize the data
loading process. This is currently being tracked in
[this issue](https://github.com/Jena-Earth-Observation-School/sdc-tools/issues/7).
```

The following basic example shows how to load Sentinel-2 L2A data for the year
2020 of an area of interest, which has been saved locally as a vector file:
Expand All @@ -40,9 +47,11 @@ supported at the moment:
- `"mswep"`: Multi-Source Weighted-Ensemble Precipitation (MSWEP) daily
- `vec`: Filter the returned data spatially by either providing the name of a
SALDi site in the format `"siteXX"`, where XX is the site number (e.g.
`"site06"`), or a vector file path defining an area of interest as a subset of
a SALDi site. Providing a vector file outside the spatial extent of the SALDi
sites will result in an empty dataset.
`"site06"`), or a path to a vector file (any format [fiona](https://github.com/Toblerity/Fiona)
can handle, e.g. `.geojson`, `.shp`, `.gpkg`) that defines an area of interest
as a subset of a SALDi site. Providing a vector file outside the spatial extent
of the SALDi sites will result in an empty dataset. Please note, that always the
bounding box of the provided geometry will be used to load the data.
- `time_range`: Filter the returned data temporally by providing a tuple of
strings in the format `("YY-MM-dd", "YY-MM-dd")`, or `None` to return all
available data.
Expand All @@ -61,13 +70,6 @@ defining an area of interest (e.g., using https://geojson.io/). Develop your
workflow on a small subset of the data before scaling up.
```

(advanced-loading)=
## Advanced loading options

_Coming soon..._

![https://media.giphy.com/media/fky7SCCsAqGZy/giphy.gif](https://media.giphy.com/media/fky7SCCsAqGZy/giphy.gif)

(xarray-dask-intro)=
## Xarray, Dask and lazy loading

Expand Down

0 comments on commit de0d4ea

Please sign in to comment.