Skip to content

Commit 13996f0

Browse files
committed
Add example using since and until parameters.
1 parent 73795c2 commit 13996f0

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

sensors/06-list-datasets-by-plot.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ from the workbench or Globus.
66

77
## Getting started
88

9-
After installing terrautils, you should be able to import the *prooduct* module.
9+
After installing terrautils, you should be able to import the *product* module.
1010
```
1111
from terrautils.products import get_sensor_list, unique_sensor_names
1212
from terrautils.products import get_file_listing, extract_file_paths
@@ -20,17 +20,18 @@ The *key* is a unique access key for the Clowder api.
2020
## Getting the sensor list
2121
The first thing to get is the sensor name. This can be retreived using the
2222
get\_sensor\_list function. This function returns the full record which may
23-
be useful in some cases but also includes sensor names that include a plot id
24-
number. The utility function unique_sensor_names accpets the sensor list and
25-
provides a list of names suitable for use in the get_file_listing function.
23+
be useful in some cases but primarily includes sensor names that include
24+
a plot id number. The utility function unique_sensor_names accpets the
25+
sensor list and provides a list of names suitable for use in the
26+
get_file_listing function.
2627

2728
```
2829
sensors = get_sensor_list(None, url, key)
2930
names = unique_sensor_names(sensors)
3031
```
3132

32-
Names will now contain a list of sensor names support by the Clowder geostreams
33-
API. The currently available sensors are:
33+
Names will now contain a list of sensor names available in the Clowder
34+
geostreams API. The currently available sensors are:
3435

3536
* IR Surface Temperature
3637
* Thermal IR GeoTIFFs Datasets
@@ -61,6 +62,14 @@ datasets = get_file_listing(None, url, key, sensor, sitename)
6162
files = extract_file_paths(datasets)
6263
```
6364

65+
Datasets can be further filtered using the *since* and *until* parameters
66+
of get\_file\_listing with a date string.
67+
68+
```
69+
dataset = get_file_listing(None, url, key, sensor, sitename,
70+
since='2016-06-01', until='2016-06-10')
71+
```
72+
6473

6574
# Alternative method
6675
The following method demonstrates the same approach using the Clowder API. This

0 commit comments

Comments
 (0)