Skip to content

Commit 551a4f2

Browse files
martiboschmartibosch
committed
docs: updated README and CHANGELOG [ci skip]
1 parent 18fcc63 commit 551a4f2

File tree

2 files changed

+27
-321
lines changed

2 files changed

+27
-321
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# CHANGELOG
22

3-
## v0.0.0 - 2025-04-04
3+
## v0.1.0 - 2025-04-06
44

5-
- initial commit
5+
- first release

‎README.md‎

Lines changed: 25 additions & 319 deletions
Original file line numberDiff line numberDiff line change
@@ -38,152 +38,13 @@ latest_alti3d_gdf = swisstopopy.get_latest(alti3d_gdf)
3838
latest_alti3d_gdf.head()
3939
```
4040

41-
<div>
42-
<table border="1" class="dataframe">
43-
<thead>
44-
<tr style="text-align: right;">
45-
<th></th>
46-
<th>id</th>
47-
<th>collection</th>
48-
<th>type</th>
49-
<th>stac_version</th>
50-
<th>bbox</th>
51-
<th>stac_extensions</th>
52-
<th>links</th>
53-
<th>geometry.type</th>
54-
<th>geometry.coordinates</th>
55-
<th>properties.datetime</th>
56-
<th>properties.created</th>
57-
<th>properties.updated</th>
58-
<th>geometry</th>
59-
<th>assets.checksum:multihash</th>
60-
<th>assets.created</th>
61-
<th>assets.eo:gsd</th>
62-
<th>assets.href</th>
63-
<th>assets.proj:epsg</th>
64-
<th>assets.type</th>
65-
<th>assets.updated</th>
66-
</tr>
67-
</thead>
68-
<tbody>
69-
<tr>
70-
<th>0</th>
71-
<td>swissalti3d_2021_2532-1151</td>
72-
<td>ch.swisstopo.swissalti3d</td>
73-
<td>Feature</td>
74-
<td>0.9.0</td>
75-
<td>[6.5525481, 46.5068432, 6.565723, 46.5159392]</td>
76-
<td>[https://stac-extensions.github.io/timestamps/...</td>
77-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
78-
<td>Polygon</td>
79-
<td>[[[6.5526955, 46.5068432], [6.565723, 46.50694...</td>
80-
<td>2021-01-01 00:00:00+00:00</td>
81-
<td>2021-09-02 16:46:12.695971+00:00</td>
82-
<td>2025-01-18 02:03:21.314035+00:00</td>
83-
<td>POLYGON ((6.56572 46.50684, 6.56572 46.51594, ...</td>
84-
<td>1220A1EB829DC0AEFA4B10F687F5C05FC2AA4F59F6B622...</td>
85-
<td>2021-09-02T19:09:22.472399Z</td>
86-
<td>0.5</td>
87-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
88-
<td>2056.0</td>
89-
<td>application/x.ascii-xyz+zip</td>
90-
<td>2025-01-18T00:05:10.539193Z</td>
91-
</tr>
92-
<tr>
93-
<th>1</th>
94-
<td>swissalti3d_2021_2532-1151</td>
95-
<td>ch.swisstopo.swissalti3d</td>
96-
<td>Feature</td>
97-
<td>0.9.0</td>
98-
<td>[6.5525481, 46.5068432, 6.565723, 46.5159392]</td>
99-
<td>[https://stac-extensions.github.io/timestamps/...</td>
100-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
101-
<td>Polygon</td>
102-
<td>[[[6.5526955, 46.5068432], [6.565723, 46.50694...</td>
103-
<td>2021-01-01 00:00:00+00:00</td>
104-
<td>2021-09-02 16:46:12.695971+00:00</td>
105-
<td>2025-01-18 02:03:21.314035+00:00</td>
106-
<td>POLYGON ((6.56572 46.50684, 6.56572 46.51594, ...</td>
107-
<td>12203761E09265F46BC92A89AB60D7003202574ADBED5B...</td>
108-
<td>2021-09-02T16:46:13.207732Z</td>
109-
<td>2.0</td>
110-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
111-
<td>2056.0</td>
112-
<td>application/x.ascii-xyz+zip</td>
113-
<td>2025-01-17T23:06:08.845852Z</td>
114-
</tr>
115-
<tr>
116-
<th>2</th>
117-
<td>swissalti3d_2021_2532-1151</td>
118-
<td>ch.swisstopo.swissalti3d</td>
119-
<td>Feature</td>
120-
<td>0.9.0</td>
121-
<td>[6.5525481, 46.5068432, 6.565723, 46.5159392]</td>
122-
<td>[https://stac-extensions.github.io/timestamps/...</td>
123-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
124-
<td>Polygon</td>
125-
<td>[[[6.5526955, 46.5068432], [6.565723, 46.50694...</td>
126-
<td>2021-01-01 00:00:00+00:00</td>
127-
<td>2021-09-02 16:46:12.695971+00:00</td>
128-
<td>2025-01-18 02:03:21.314035+00:00</td>
129-
<td>POLYGON ((6.56572 46.50684, 6.56572 46.51594, ...</td>
130-
<td>1220B9AD77D6DD070409D209F5ADF17EC7253FC3FE6CEE...</td>
131-
<td>2021-09-03T00:35:29.891683Z</td>
132-
<td>0.5</td>
133-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
134-
<td>2056.0</td>
135-
<td>image/tiff; application=geotiff; profile=cloud...</td>
136-
<td>2025-01-18T01:04:21.184877Z</td>
137-
</tr>
138-
<tr>
139-
<th>3</th>
140-
<td>swissalti3d_2021_2532-1151</td>
141-
<td>ch.swisstopo.swissalti3d</td>
142-
<td>Feature</td>
143-
<td>0.9.0</td>
144-
<td>[6.5525481, 46.5068432, 6.565723, 46.5159392]</td>
145-
<td>[https://stac-extensions.github.io/timestamps/...</td>
146-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
147-
<td>Polygon</td>
148-
<td>[[[6.5526955, 46.5068432], [6.565723, 46.50694...</td>
149-
<td>2021-01-01 00:00:00+00:00</td>
150-
<td>2021-09-02 16:46:12.695971+00:00</td>
151-
<td>2025-01-18 02:03:21.314035+00:00</td>
152-
<td>POLYGON ((6.56572 46.50684, 6.56572 46.51594, ...</td>
153-
<td>122093E32E6D175B9F148409FCAA8708073303A8E94A8E...</td>
154-
<td>2021-09-03T01:36:23.594881Z</td>
155-
<td>2.0</td>
156-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
157-
<td>2056.0</td>
158-
<td>image/tiff; application=geotiff; profile=cloud...</td>
159-
<td>2025-01-18T02:03:21.314035Z</td>
160-
</tr>
161-
<tr>
162-
<th>4</th>
163-
<td>swissalti3d_2021_2532-1152</td>
164-
<td>ch.swisstopo.swissalti3d</td>
165-
<td>Feature</td>
166-
<td>0.9.0</td>
167-
<td>[6.5524006, 46.5158382, 6.5655778, 46.5249343]</td>
168-
<td>[https://stac-extensions.github.io/timestamps/...</td>
169-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
170-
<td>Polygon</td>
171-
<td>[[[6.5525481, 46.5158382], [6.5655778, 46.5159...</td>
172-
<td>2021-01-01 00:00:00+00:00</td>
173-
<td>2021-09-02 16:56:28.144164+00:00</td>
174-
<td>2025-01-18 02:16:20.318007+00:00</td>
175-
<td>POLYGON ((6.56558 46.51584, 6.56558 46.52493, ...</td>
176-
<td>122020D17CB98AAE4FECDBC563D0673AF8797EFD2D74C6...</td>
177-
<td>2021-09-02T20:24:35.219858Z</td>
178-
<td>0.5</td>
179-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
180-
<td>2056.0</td>
181-
<td>application/x.ascii-xyz+zip</td>
182-
<td>2025-01-18T00:17:16.038110Z</td>
183-
</tr>
184-
</tbody>
185-
</table>
186-
</div>
41+
| | id | collection | ... | geometry |
42+
| --- | -------------------------- | ------------------------ | --- | ------------------------------------------------- |
43+
| 0 | swissalti3d_2021_2532-1151 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56572 46.50684, 6.56572 46.51594, ... |
44+
| 1 | swissalti3d_2021_2532-1151 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56572 46.50684, 6.56572 46.51594, ... |
45+
| 2 | swissalti3d_2021_2532-1151 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56572 46.50684, 6.56572 46.51594, ... |
46+
| 3 | swissalti3d_2021_2532-1151 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56572 46.50684, 6.56572 46.51594, ... |
47+
| 4 | swissalti3d_2021_2532-1152 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56558 46.51584, 6.56558 46.52493, ... |
18748

18849
or filter by other metadata attributes such as ground resolution and/or file extensions:
18950

@@ -194,175 +55,14 @@ alti3d_gdf[
19455
]
19556
```
19657

197-
<div>
198-
<table border="1" class="dataframe">
199-
<thead>
200-
<tr style="text-align: right;">
201-
<th></th>
202-
<th>id</th>
203-
<th>collection</th>
204-
<th>type</th>
205-
<th>stac_version</th>
206-
<th>bbox</th>
207-
<th>stac_extensions</th>
208-
<th>links</th>
209-
<th>geometry.type</th>
210-
<th>geometry.coordinates</th>
211-
<th>properties.datetime</th>
212-
<th>properties.created</th>
213-
<th>properties.updated</th>
214-
<th>geometry</th>
215-
<th>assets.checksum:multihash</th>
216-
<th>assets.created</th>
217-
<th>assets.eo:gsd</th>
218-
<th>assets.href</th>
219-
<th>assets.proj:epsg</th>
220-
<th>assets.type</th>
221-
<th>assets.updated</th>
222-
</tr>
223-
</thead>
224-
<tbody>
225-
<tr>
226-
<th>0</th>
227-
<td>swissalti3d_2019_2532-1151</td>
228-
<td>ch.swisstopo.swissalti3d</td>
229-
<td>Feature</td>
230-
<td>0.9.0</td>
231-
<td>[6.5525481, 46.5068432, 6.565723, 46.5159392]</td>
232-
<td>[https://stac-extensions.github.io/timestamps/...</td>
233-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
234-
<td>Polygon</td>
235-
<td>[[[6.5526955, 46.5068432], [6.565723, 46.50694...</td>
236-
<td>2019-01-01 00:00:00+00:00</td>
237-
<td>2021-02-10 10:47:06.111266+00:00</td>
238-
<td>2025-01-16 14:51:17.195380+00:00</td>
239-
<td>POLYGON ((6.56572 46.50684, 6.56572 46.51594, ...</td>
240-
<td>1220BEF35C33758E7EA4744487F4D8248AABFD50018615...</td>
241-
<td>2021-02-10T10:47:06.715269Z</td>
242-
<td>0.5</td>
243-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
244-
<td>2056.0</td>
245-
<td>image/tiff; application=geotiff; profile=cloud...</td>
246-
<td>2025-01-14T19:16:07.401260Z</td>
247-
</tr>
248-
<tr>
249-
<th>4</th>
250-
<td>swissalti3d_2019_2532-1152</td>
251-
<td>ch.swisstopo.swissalti3d</td>
252-
<td>Feature</td>
253-
<td>0.9.0</td>
254-
<td>[6.5524006, 46.5158382, 6.5655778, 46.5249343]</td>
255-
<td>[https://stac-extensions.github.io/timestamps/...</td>
256-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
257-
<td>Polygon</td>
258-
<td>[[[6.5525481, 46.5158382], [6.5655778, 46.5159...</td>
259-
<td>2019-01-01 00:00:00+00:00</td>
260-
<td>2021-02-10 10:49:41.964859+00:00</td>
261-
<td>2025-01-16 15:06:19.535010+00:00</td>
262-
<td>POLYGON ((6.56558 46.51584, 6.56558 46.52493, ...</td>
263-
<td>12205790D9862A7BFB265E59B08814D8E44227441DD80B...</td>
264-
<td>2021-02-10T10:49:42.615492Z</td>
265-
<td>0.5</td>
266-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
267-
<td>2056.0</td>
268-
<td>image/tiff; application=geotiff; profile=cloud...</td>
269-
<td>2025-01-14T19:26:09.858728Z</td>
270-
</tr>
271-
<tr>
272-
<th>8</th>
273-
<td>swissalti3d_2019_2533-1152</td>
274-
<td>ch.swisstopo.swissalti3d</td>
275-
<td>Feature</td>
276-
<td>0.9.0</td>
277-
<td>[6.5654325, 46.5159392, 6.5786075, 46.5250338]</td>
278-
<td>[https://stac-extensions.github.io/timestamps/...</td>
279-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
280-
<td>Polygon</td>
281-
<td>[[[6.5655778, 46.5159392], [6.5786075, 46.5160...</td>
282-
<td>2019-01-01 00:00:00+00:00</td>
283-
<td>2021-02-10 10:49:43.859413+00:00</td>
284-
<td>2025-01-16 15:06:20.632461+00:00</td>
285-
<td>POLYGON ((6.57861 46.51594, 6.57861 46.52503, ...</td>
286-
<td>1220788F6FB6067294E92CE78ACBC070B25CB9632D5910...</td>
287-
<td>2021-02-10T10:49:44.535488Z</td>
288-
<td>0.5</td>
289-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
290-
<td>2056.0</td>
291-
<td>image/tiff; application=geotiff; profile=cloud...</td>
292-
<td>2025-01-14T19:26:10.809428Z</td>
293-
</tr>
294-
<tr>
295-
<th>12</th>
296-
<td>swissalti3d_2021_2532-1151</td>
297-
<td>ch.swisstopo.swissalti3d</td>
298-
<td>Feature</td>
299-
<td>0.9.0</td>
300-
<td>[6.5525481, 46.5068432, 6.565723, 46.5159392]</td>
301-
<td>[https://stac-extensions.github.io/timestamps/...</td>
302-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
303-
<td>Polygon</td>
304-
<td>[[[6.5526955, 46.5068432], [6.565723, 46.50694...</td>
305-
<td>2021-01-01 00:00:00+00:00</td>
306-
<td>2021-09-02 16:46:12.695971+00:00</td>
307-
<td>2025-01-18 02:03:21.314035+00:00</td>
308-
<td>POLYGON ((6.56572 46.50684, 6.56572 46.51594, ...</td>
309-
<td>1220B9AD77D6DD070409D209F5ADF17EC7253FC3FE6CEE...</td>
310-
<td>2021-09-03T00:35:29.891683Z</td>
311-
<td>0.5</td>
312-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
313-
<td>2056.0</td>
314-
<td>image/tiff; application=geotiff; profile=cloud...</td>
315-
<td>2025-01-18T01:04:21.184877Z</td>
316-
</tr>
317-
<tr>
318-
<th>16</th>
319-
<td>swissalti3d_2021_2532-1152</td>
320-
<td>ch.swisstopo.swissalti3d</td>
321-
<td>Feature</td>
322-
<td>0.9.0</td>
323-
<td>[6.5524006, 46.5158382, 6.5655778, 46.5249343]</td>
324-
<td>[https://stac-extensions.github.io/timestamps/...</td>
325-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
326-
<td>Polygon</td>
327-
<td>[[[6.5525481, 46.5158382], [6.5655778, 46.5159...</td>
328-
<td>2021-01-01 00:00:00+00:00</td>
329-
<td>2021-09-02 16:56:28.144164+00:00</td>
330-
<td>2025-01-18 02:16:20.318007+00:00</td>
331-
<td>POLYGON ((6.56558 46.51584, 6.56558 46.52493, ...</td>
332-
<td>122089C474AEF62CC4692D7A944AFC0A13162D3DD8D0CF...</td>
333-
<td>2021-09-03T00:49:42.276133Z</td>
334-
<td>0.5</td>
335-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
336-
<td>2056.0</td>
337-
<td>image/tiff; application=geotiff; profile=cloud...</td>
338-
<td>2025-01-18T01:18:11.426964Z</td>
339-
</tr>
340-
<tr>
341-
<th>20</th>
342-
<td>swissalti3d_2021_2533-1152</td>
343-
<td>ch.swisstopo.swissalti3d</td>
344-
<td>Feature</td>
345-
<td>0.9.0</td>
346-
<td>[6.5654325, 46.5159392, 6.5786075, 46.5250338]</td>
347-
<td>[https://stac-extensions.github.io/timestamps/...</td>
348-
<td>[{'rel': 'self', 'href': 'https://data.geo.adm...</td>
349-
<td>Polygon</td>
350-
<td>[[[6.5655778, 46.5159392], [6.5786075, 46.5160...</td>
351-
<td>2021-01-01 00:00:00+00:00</td>
352-
<td>2021-09-02 16:56:34.537212+00:00</td>
353-
<td>2025-01-18 02:17:06.919621+00:00</td>
354-
<td>POLYGON ((6.57861 46.51594, 6.57861 46.52503, ...</td>
355-
<td>1220B8B7EA9C14DD41021131A873BD5B76DC0642CBC374...</td>
356-
<td>2021-09-03T00:49:54.457903Z</td>
357-
<td>0.5</td>
358-
<td>https://data.geo.admin.ch/ch.swisstopo.swissal...</td>
359-
<td>2056.0</td>
360-
<td>image/tiff; application=geotiff; profile=cloud...</td>
361-
<td>2025-01-18T01:18:15.270233Z</td>
362-
</tr>
363-
</tbody>
364-
</table>
365-
</div>
58+
| | id | collection | ... | geometry |
59+
| --- | -------------------------- | ------------------------ | --- | ------------------------------------------------- |
60+
| 0 | swissalti3d_2019_2532-1151 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56572 46.50684, 6.56572 46.51594, ... |
61+
| 4 | swissalti3d_2019_2532-1152 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56558 46.51584, 6.56558 46.52493, ... |
62+
| 8 | swissalti3d_2019_2533-1152 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.57861 46.51594, 6.57861 46.52503, ... |
63+
| 12 | swissalti3d_2021_2532-1151 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56572 46.50684, 6.56572 46.51594, ... |
64+
| 16 | swissalti3d_2021_2532-1152 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.56558 46.51584, 6.56558 46.52493, ... |
65+
| 20 | swissalti3d_2021_2533-1152 | ch.swisstopo.swissalti3d | ... | POLYGON ((6.57861 46.51594, 6.57861 46.52503, ... |
36666

36767
### STAC data processing
36868

@@ -385,14 +85,20 @@ See the [overview notebook](https://swisstopopy.readthedocs.io/en/latest/overvie
38585

38686
## Installation
38787

388-
You can install swisstopopy using pip:
88+
Like many other geospatial Python packages, swisstopopy requires many base C libraries that cannot be installed with pip. Accordingly, the best way to install swisstopopy is to use conda/mamba, i.e., in a given conda environment, run:
38989

39090
```bash
391-
# or pip install -e git+ssh://[email protected]/martibosch/swisstopopy
392-
pip install https://github.com/martibosch/swisstopopy/archive/main.zip
91+
# or mamba install -c conda-forge geopandas
92+
conda install -c conda-forge geopandas
39393
```
39494

395-
Note that the `get_tree_canopy_raster` requires [PDAL and its Python bindings](https://pdal.io/en/2.8.4/python.html), which are not installed by default with swisstopopy. The [easiest way to install such requirements is using conda/mamba](https://pdal.io/en/latest/python.html#install-using-conda), e.g.: `conda install -c conda-forge python-pdal`.
95+
Within the same conda environment, you can then install swisstopopy using pip:
96+
97+
```bash
98+
pip install swisstopopy
99+
```
100+
101+
Note that the `get_tree_canopy_raster` requires [PDAL and its Python bindings](https://pdal.io/en/2.8.4/python.html), which are not installed by default with swisstopopy. Like with geopandas, the [easiest way to install such requirements is using conda/mamba](https://pdal.io/en/latest/python.html#install-using-conda), e.g.: `conda install -c conda-forge python-pdal`.
396102

397103
## Notes
398104

0 commit comments

Comments
 (0)