Skip to content

Commit 9eeed04

Browse files
jreiberkylejreiberkyle
authored
Merge pull request planetlabs#120 from planetlabs/gather-aois-119
collect AOIs used in repository into one geojson and add maintenance notes in CONTRIBUTING
2 parents ce07462 + 3a1314f commit 9eeed04

File tree

5 files changed

+928
-3
lines changed

5 files changed

+928
-3
lines changed

‎CONTRIBUTING.md‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,24 @@ because pytest does not like spaces in command line arguments.
1111

1212
When a new notebook has a dependency that is not yet supported by the Docker image,
1313
a new Docker image must be built. Additionally, add the new dependency to the
14-
[imports_test notebook](development-notebooks/imports_test.ipynb).
14+
[imports_test notebook](dev/imports_test.ipynb).
15+
16+
## Area of Interest
17+
18+
The first choice of area of interest (AOI) for any notebook is an AOI that is
19+
already used in this repository. The geojson description of these AOIs is given
20+
in [aois.geojson](dev/imports_test.ipynb) (it is easy to visualize these
21+
aois directly in GitHub or by copy/pasting into [geojson.io](geojson.io).
22+
These AOIs are also given in the
23+
[repository_aois notebook](dev/repository_aois.ipynb). It is good practice
24+
to add your notebook to the list of notebooks using each AOI.
25+
26+
If the AOI for a notebook cannot be satisfied by the the AOIs already in use
27+
in the repository, then email <[email protected]> so that we can consider
28+
expanding our demo data coverage to include a new AOI. If the new AOI is included,
29+
add the AOI to the
30+
[repository_aois notebook](dev/repository_aois.ipynb). Run that notebook
31+
through to the end to update [aois.geojson](dev/imports_test.ipynb).
1532

1633
## Skipping Validation
1734

@@ -28,15 +45,18 @@ skipped, it will not be guaranteed to be supported by the Docker image.**
2845

2946
**Every time** the Docker image is changed, at the very least ensure that the
3047
python packages still import without error by running the
31-
[imports_test notebook](development-notebooks/imports_test.ipynb).
48+
[imports_test notebook](dev/imports_test.ipynb).
3249

3350
It is also strongly recommended that you ensure the Docker image can run all
3451
of the notebooks in the repository. This can be accomplished by automatically
3552
running all of the notebooks using the supplied test script. To run the test script,
3653
run the notebook in interactive mode, achieved by adding `/bin/bash` to
3754
the container run command, e.g.
3855
```bash
39-
docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks /bin/bash
56+
docker run -it --rm -p 8888:8888 \
57+
-v $PWD:/home/jovyan/work \
58+
-e PL_API_KEY='[YOUR-API-KEY]' \
59+
planet-notebooks /bin/bash
4060
```
4161

4262
From the root directory within the docker container, run one of the following:

‎dev/aois.geojson‎

Lines changed: 321 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,321 @@
1+
{
2+
"type": "FeatureCollection",
3+
"features": [
4+
{
5+
"type": "Feature",
6+
"geometry": {
7+
"type": "Polygon",
8+
"coordinates": [
9+
[
10+
[-93.299129, 42.699599],
11+
[-93.299674, 42.812757],
12+
[-93.288436, 42.861921],
13+
[-93.265332, 42.924817],
14+
[-92.993873, 42.925124],
15+
[-92.993888, 42.773637],
16+
[-92.998396, 42.754529],
17+
[-93.019154, 42.699988],
18+
[-93.299129, 42.699599]
19+
]
20+
]
21+
},
22+
"properties": {
23+
"name": "iowa_crops",
24+
"used by": [
25+
"crop_classification/classify_cart_l8_ps"
26+
]
27+
}
28+
},
29+
{
30+
"type": "Feature",
31+
"geometry": {
32+
"type": "Polygon",
33+
"coordinates": [
34+
[
35+
[-121.58461, 38.291705],
36+
[-121.58461, 38.327265],
37+
[-121.524872, 38.327265],
38+
[-121.524872, 38.291705],
39+
[-121.58461, 38.291705]
40+
]
41+
]
42+
},
43+
"properties": {
44+
"name": "sacramento_crops",
45+
"used by": [
46+
"crop_classification/datasets_identify-1"
47+
]
48+
}
49+
},
50+
{
51+
"type": "Feature",
52+
"geometry": {
53+
"type": "Polygon",
54+
"coordinates": [
55+
[
56+
[-121.311325, 38.28912],
57+
[-121.311325, 38.346225],
58+
[-121.234421, 38.346225],
59+
[-121.234421, 38.28912],
60+
[-121.311325, 38.28912]
61+
]
62+
]
63+
},
64+
"properties": {
65+
"name": "sacramento_crops_2",
66+
"used by": [
67+
"coverage/calculage_coverage_wgs84",
68+
"crossovers/ps_l8_crossovers",
69+
"landsat-ps-comparison/landsat-ps-comparison",
70+
"crop_classification/datasets_identify-2"
71+
]
72+
}
73+
},
74+
{
75+
"type": "Feature",
76+
"geometry": {
77+
"type": "Polygon",
78+
"coordinates": [
79+
[
80+
[-122.511034, 37.771597],
81+
[-122.510605, 37.763998],
82+
[-122.459021, 37.766033],
83+
[-122.457733, 37.76549],
84+
[-122.452755, 37.766372],
85+
[-122.454557, 37.775125],
86+
[-122.465973, 37.773836],
87+
[-122.511034, 37.771597]
88+
]
89+
]
90+
},
91+
"properties": {
92+
"name": "golden_gate_park",
93+
"used by": [
94+
"data-api-tutorials/clip_and_ship_introduction"
95+
]
96+
}
97+
},
98+
{
99+
"type": "Feature",
100+
"geometry": {
101+
"type": "Polygon",
102+
"coordinates": [
103+
[
104+
[-122.474556, 37.810326],
105+
[-122.491722, 37.795407],
106+
[-122.520561, 37.784283],
107+
[-122.519531, 37.697133],
108+
[-122.389412, 37.694416],
109+
[-122.388725, 37.70501],
110+
[-122.362289, 37.709356],
111+
[-122.34993, 37.72728],
112+
[-122.377739, 37.762301],
113+
[-122.384949, 37.794593],
114+
[-122.405548, 37.81331],
115+
[-122.46151, 37.805715],
116+
[-122.474556, 37.810326]
117+
]
118+
]
119+
},
120+
"properties": {
121+
"name": "san_francisco_city",
122+
"used by": [
123+
"data-api-tutorials/planet_cli_introduction"
124+
]
125+
}
126+
},
127+
{
128+
"type": "Feature",
129+
"geometry": {
130+
"type": "Polygon",
131+
"coordinates": [
132+
[
133+
[-125.296326, 48.370848],
134+
[-125.296326, 49.335862],
135+
[-123.239136, 49.335862],
136+
[-123.239136, 48.370848],
137+
[-125.296326, 48.370848]
138+
]
139+
]
140+
},
141+
"properties": {
142+
"name": "Vancouver Island South",
143+
"used by": [
144+
"data-api-tutorials/planet_data_api_introduction"
145+
]
146+
}
147+
},
148+
{
149+
"type": "Feature",
150+
"geometry": {
151+
"type": "Polygon",
152+
"coordinates": [
153+
[
154+
[-121.592903, 37.93445],
155+
[-121.27018, 37.93445],
156+
[-121.27018, 38.065933],
157+
[-121.592903, 38.065933],
158+
[-121.592903, 37.93445]
159+
]
160+
]
161+
},
162+
"properties": {
163+
"name": "West of Stockton",
164+
"used by": [
165+
"data-api-tutorials/search_and_download_quickstart",
166+
"ndvi-from-sr/ndvi_planetscope_sr",
167+
"ndvi/ndvi_planetscope"
168+
]
169+
}
170+
},
171+
{
172+
"type": "Feature",
173+
"geometry": {
174+
"type": "Polygon",
175+
"coordinates": [
176+
[
177+
[25.424295, 1.025538],
178+
[25.592961, 1.025538],
179+
[25.592961, 1.119658],
180+
[25.424295, 1.119658],
181+
[25.424295, 1.025538]
182+
]
183+
]
184+
},
185+
"properties": {
186+
"name": "congo_forest",
187+
"used by": [
188+
"forest-monitoring/drc_roads_download"
189+
]
190+
}
191+
},
192+
{
193+
"type": "Feature",
194+
"geometry": {
195+
"type": "Polygon",
196+
"coordinates": [
197+
[
198+
[-119.161835, 37.82904],
199+
[-119.149475, 37.836632],
200+
[-119.137459, 37.846393],
201+
[-119.135742, 37.856423],
202+
[-119.138832, 37.866452],
203+
[-119.124069, 37.869162],
204+
[-119.122009, 37.875937],
205+
[-119.121269, 37.905724],
206+
[-119.137405, 37.930641],
207+
[-119.165955, 37.926597],
208+
[-119.182434, 37.944739],
209+
[-119.208816, 37.952573],
210+
[-119.255165, 37.925225],
211+
[-119.263061, 37.882153],
212+
[-119.251045, 37.844748],
213+
[-119.182037, 37.825768],
214+
[-119.161835, 37.82904]
215+
]
216+
]
217+
},
218+
"properties": {
219+
"name": "Mt Dana",
220+
"used by": [
221+
"in-class-exercises/mosaicing-and-masking/mosaicing-and-masking-key",
222+
"mosaicing/basic_compositing_demo"
223+
]
224+
}
225+
},
226+
{
227+
"type": "Feature",
228+
"geometry": {
229+
"type": "Polygon",
230+
"coordinates": [
231+
[
232+
[105.817754, 20.840158],
233+
[105.911143, 20.840158],
234+
[105.911143, 20.925748],
235+
[105.817754, 20.925748],
236+
[105.817754, 20.840158]
237+
]
238+
]
239+
},
240+
"properties": {
241+
"name": "S Hanoi",
242+
"used by": [
243+
"label-data/label_maker_pl_geotiff"
244+
]
245+
}
246+
},
247+
{
248+
"type": "Feature",
249+
"geometry": {
250+
"type": "Polygon",
251+
"coordinates": [
252+
[
253+
[94.251427, 16.942923],
254+
[95.954314, 16.587049],
255+
[95.558022, 14.851752],
256+
[93.870021, 15.209871],
257+
[94.251427, 16.942923]
258+
]
259+
]
260+
},
261+
"properties": {
262+
"name": "S Myanmar",
263+
"used by": [
264+
"orders/ordering_and_delivery",
265+
"orders/tools_and_toolchains"
266+
]
267+
}
268+
},
269+
{
270+
"type": "Feature",
271+
"geometry": {
272+
"type": "Polygon",
273+
"coordinates": [
274+
[
275+
[-120.532827, 37.387201],
276+
[-120.52355, 37.420706],
277+
[-120.238581, 37.370892],
278+
[-120.241403, 37.360771],
279+
[-120.240471, 37.360609],
280+
[-120.253099, 37.314184],
281+
[-120.257813, 37.297341],
282+
[-120.543562, 37.347297],
283+
[-120.532827, 37.387201]
284+
]
285+
]
286+
},
287+
"properties": {
288+
"name": "North of Merced",
289+
"used by": [
290+
"toar/toar_planetscope"
291+
]
292+
}
293+
},
294+
{
295+
"type": "Feature",
296+
"geometry": {
297+
"type": "Polygon",
298+
"coordinates": [
299+
[
300+
[-93.299058, 42.699587],
301+
[-93.299658, 42.812899],
302+
[-93.288415, 42.862023],
303+
[-93.265369, 42.924747],
304+
[-92.993887, 42.925124],
305+
[-92.993887, 42.773598],
306+
[-92.998393, 42.754505],
307+
[-93.019164, 42.699966],
308+
[-93.299058, 42.699587]
309+
]
310+
]
311+
},
312+
"properties": {
313+
"name": "iowa_crops_2",
314+
"used by": [
315+
"udm/udm",
316+
"udm/udm2"
317+
]
318+
}
319+
}
320+
]
321+
}

‎development-notebooks/imports_test.ipynb‎ renamed to ‎dev/imports_test.ipynb‎

File renamed without changes.

0 commit comments

Comments
 (0)