├── lib └── streamlit_keplergl │ ├── __pycache__ │ └── __init__.cpython-37.pyc │ └── __init__.py ├── requirements.txt ├── README.md ├── app.py └── LICENSE /lib/streamlit_keplergl/__pycache__/__init__.cpython-37.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mykolakozyr/stacdiscovery/HEAD/lib/streamlit_keplergl/__pycache__/__init__.cpython-37.pyc -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | streamlit==1.30.0 # Modern, stable – lots of new features 2 | protobuf==4.25.3 # Required for new Streamlit versions 3 | pandas==2.2.1 # Compatible with Streamlit + GeoPandas 4 | geopandas==0.14.3 # Up-to-date & stable 5 | keplergl==0.3.2 # No change (latest) 6 | Shapely==2.0.3 # Required for newer GeoPandas 7 | pystac==1.9.0 # Latest stable (or >=1.5 for full STAC v1) 8 | pystac-client==0.7.5 # Compatible with STAC API spec 1.0.0+ 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # STAC Catalog Discovery 2 | Simple [STAC](http://stacspec.org/) discovery tool. Just paste the STAC Catalog link and press Enter. 3 | 4 | ![](https://user-images.githubusercontent.com/17071295/149538139-e021a5e9-cdf2-4e8c-a785-9209b26b42d6.gif) 5 | 6 | ## Details 7 | STAC Discovery tool enables discovering data in a given collection. The idea is to move from the approach of providing geometry and dates to discovering the whole catalog. 8 | The main idea is to showcase the value of using **[STAC specification](http://stacspec.org/)** in describing geospatial information. Just imagine how great would it be to have a single interface to browse geospatial data. 9 | 10 | Please note, it is not the best tool to discover data from large data catalogs. Use tools that designed to return first N items for a given area of interest. 11 | 12 | This STAC Discovery tool is based on the [pystac-client](https://pystac-client.readthedocs.io/en/latest/) v.0.3.1. 13 | ## Known Limitations 14 | - :warning: It requires STAC spec v1.0.0 15 | - :warning: Number of items to return is limited to 25000 16 | -------------------------------------------------------------------------------- /lib/streamlit_keplergl/__init__.py: -------------------------------------------------------------------------------- 1 | # Load kepler.gl with an empty map 2 | 3 | import streamlit.components.v1 as components 4 | from keplergl import KeplerGl 5 | 6 | 7 | def keplergl_static( 8 | fig: KeplerGl, height: int = 400, scrolling=False 9 | ) -> components.html: 10 | """ 11 | Renders `keplergl.KeplerGl` map figure in a Streamlit app. This method is 12 | a static Streamlit Component, meaning, no information is passed back from 13 | KeplerGL on browser interaction. 14 | 15 | Args: 16 | fig: `keplergl.KeplerGl` map figure. 17 | height: Height of result. If `height` is set on the keplergl.KeplerGl` object, 18 | that value supersedes the values set with the keyword arguments of this 19 | function. 20 | width: Width of result. 21 | 22 | Example: 23 | ```python 24 | >>> map_1 = KeplerGl(height=400) 25 | >>> keplergl_static(map_1) 26 | ``` 27 | """ 28 | try: 29 | html = fig._repr_html_() 30 | except AttributeError: 31 | raise TypeError("fig argument has to be a keplergl map object of type keplergl.KeplerGl!") 32 | 33 | return components.html( 34 | html, height=(fig.height or height) + 10, scrolling=scrolling 35 | ) 36 | -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | import streamlit as st 2 | 3 | import pandas as pd 4 | import itertools 5 | import geopandas as gpd 6 | 7 | from lib.streamlit_keplergl import keplergl_static 8 | from keplergl import KeplerGl 9 | 10 | from shapely.geometry import shape 11 | from pystac_client import Client, exceptions 12 | from pystac import catalog 13 | 14 | MAP_EMOJI_URL = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/240/apple/285/books_1f4da.png" 15 | 16 | 17 | # Set page title and favicon. 18 | st.set_page_config( 19 | page_title="STAC Discovery", 20 | page_icon=MAP_EMOJI_URL, 21 | layout="wide" 22 | ) 23 | # Display header. 24 | st.markdown("
", unsafe_allow_html=True) 25 | st.image(MAP_EMOJI_URL, width=80) 26 | 27 | """ 28 | # STAC Discovery 29 | """ 30 | 31 | def collectCollectionsInfo(root_catalog): 32 | # Expensive function. Added cache for it. 33 | 34 | # Empty list that would be used for a dataframe to collect and visualize info about collections 35 | collections_list = [] 36 | # Reading collections in the Catalog 37 | collections = list(root_catalog.get_collections()) 38 | for collection in collections: 39 | id = collection.id 40 | title = collection.title or collection.id 41 | #bbox = collection.extent.spatial.bboxes # not in use for the first release 42 | #interval = collection.extent.temporal.intervals # not in use for the first release 43 | description = collection.description 44 | 45 | # creating a list of lists of values 46 | collections_list.append([id, title, description]) 47 | return(collections_list) 48 | 49 | def collectItemsInfo(collection, limit_items): 50 | # Empty list that would be used for a dataframe to collect and visualize info about collections 51 | items_list = [] 52 | # Reading items in the collection 53 | iterable = collection.get_all_items() 54 | items = list(itertools.islice(iterable, limit_items)) #getting first 25000 items. To Do some smarter logic 55 | if len(items) == 0: 56 | st.warning(''' 57 | ⚠️ Ooops, looks like this collection does not have items 🤷‍♂️. 58 | 59 | Feel free to ping me on [Twitter](https://twitter.com/MykolaKozyr) or [LinkedIn](https://www.linkedin.com/in/mykolakozyr/) to discuss details. It's very possible I missed something. 60 | ''') 61 | st.stop() 62 | else: 63 | # Iterating over items to collect main information 64 | for item in items: 65 | id = item.id 66 | geometry = shape(item.geometry) 67 | datetime = item.datetime or item.properties['datetime'] or item.properties['end_datetime'] or item.properties['start_datetime'] 68 | links = item.links 69 | for link in links: 70 | if link.rel == 'self': 71 | self_url = link.target 72 | assets_list = [] 73 | assets = item.assets 74 | for asset in assets: 75 | assets_list.append(asset) 76 | 77 | # creating a list of lists of values 78 | items_list.append([id, geometry, datetime, self_url, assets_list]) 79 | 80 | items_df = gpd.GeoDataFrame(items_list) 81 | items_df.columns=['id', 'geometry', 'datetime', 'self_url', 'assets_list'] 82 | 83 | items_gdf = items_df.set_geometry('geometry') 84 | items_gdf["datetime"] = items_gdf["datetime"].astype(str) #specifically for KeplerGL. See https://github.com/keplergl/kepler.gl/issues/602 85 | items_gdf["assets_list"] = items_gdf["assets_list"].astype(str) #specifically for KeplerGL. See https://github.com/keplergl/kepler.gl/issues/602 86 | return(items_gdf) 87 | 88 | def selectCollection(df): 89 | # Showing Title while defining ID of the Collection 90 | CHOICES = dict(zip(df.id, df.title)) 91 | option = st.sidebar.selectbox("Select the collection", CHOICES.keys(), format_func=lambda x:CHOICES[ x ], index=0) 92 | return(option) 93 | 94 | config = { 95 | "version":"v1", 96 | "config":{ 97 | "visState":{ 98 | "filters": [ 99 | { 100 | "dataId": [ 101 | "staccollection" 102 | ], 103 | "id": "selectedcollection", 104 | "name": [ 105 | "datetime" 106 | ], 107 | "type": "timeRange", 108 | "enlarged": True, 109 | "plotType": "histogram", 110 | "animationWindow": "free", 111 | "speed": 1 112 | } 113 | ], 114 | }, 115 | "mapState":{ 116 | "bearing": 0, 117 | "latitude": 0.0, 118 | "longitude": 0.0, 119 | "pitch": 0, 120 | "zoom": 1 121 | } 122 | } 123 | } 124 | 125 | # Link to the STAC Catalog 126 | stacurl = st.sidebar.text_input('Please insert the link to the STAC Catalog', value="https://planetarycomputer.microsoft.com/api/stac/v1") 127 | with st.sidebar.expander("See examples"): 128 | st.write(""" 129 | - [Microsoft Planetary Computer STAC API](https://planetarycomputer.microsoft.com/api/stac/v1) - ⏳ 130 | - [STAC SPOT Orthoimages of Canada 2005-2010](https://canada-spot-ortho.s3.amazonaws.com/catalog.json) - ⏳⏳⏳ 131 | - [Planet Root STAC Catalog](https://www.planet.com/data/stac/catalog.json) - ⏳⏳ 132 | - [Digital Earth Africa](https://explorer.digitalearth.africa/stac/) - ⏳⏳⏳⏳ 133 | - [Digital Earth Australia](https://explorer.sandbox.dea.ga.gov.au/stac/) - ⏳⏳⏳⏳⏳ 134 | - [Global land use/land cover (LULC) map for the year 2020 at 10 meter resolution.](https://esri-lulc-2020-stac.s3.amazonaws.com/catalog.json) - ⏳⏳⏳ 135 | 136 | ⏳ - time to load 137 | """) 138 | 139 | """ 140 | [![Follow](https://img.shields.io/twitter/follow/mykolakozyr?style=social)](https://www.twitter.com/mykolakozyr) 141 |  [![Follow](https://img.shields.io/badge/LinkedIn-blue?style=flat&logo=linkedin&labelColor=blue)](https://www.linkedin.com/in/mykolakozyr/) 142 |  [![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee--yellow.svg?logo=buy-me-a-coffee&logoColor=orange&style=social)](https://www.buymeacoffee.com/mykolakozyr) 143 | ## Details 144 | STAC Discovery tool enables discovering data in a given collection. The idea is to move from the approach of providing geometry and dates to discovering the whole catalog. 145 | The main idea is to showcase the value of using **[STAC specification](http://stacspec.org/)** in describing geospatial information. Just imagine how great would it be to have a single interface to browse geospatial data. 146 | 147 | Please note, it is not the best tool to discover data from large data catalogs. Use tools that designed to return first N items for a given area of interest. 148 | 149 | This STAC Discovery tool is based on the [pystac-client](https://pystac-client.readthedocs.io/en/latest/) v.0.3.1. 150 | ### Known Limitations 151 | - :warning: It requires STAC spec v1.0.1 152 | - :warning: Max number of items to return is limited to 25000 153 | --- 154 | """ 155 | 156 | st.warning(''' 157 | ⚠️ It usually takes some time to collect information from Catalogs. 158 | 159 | Please be patient. In most cases, it worths it 😉 160 | ''') 161 | st.markdown("---") 162 | 163 | # Reading generic info about the Catalog 164 | try: 165 | root_catalog = Client.open(stacurl) 166 | except exceptions.APIError: 167 | st.warning('⚠️ Ooops, something went wrong. The PySTAC-client library returned APIError.') 168 | st.stop() 169 | except catalog.STACTypeError: 170 | st.warning('⚠️ Ooops, something went wrong. The PySTAC library returned STACTypeError.') 171 | st.stop() 172 | except: 173 | st.error(''' 174 | ⛔️ Ooops, something went wrong that is not covered by PySTAC-client library. 175 | 176 | Most likely the problem based on not compatible STAC version. 177 | Feel free to ping me on [Twitter](https://twitter.com/MykolaKozyr) or [LinkedIn](https://www.linkedin.com/in/mykolakozyr/) to discuss details. It's very possible I missed something. 178 | ''') 179 | st.stop() 180 | 181 | if root_catalog: 182 | st.sidebar.write(f"ID: {root_catalog.id}") 183 | st.sidebar.write(f"Title: {root_catalog.title or 'N/A'}") 184 | st.sidebar.write(f"Description: {root_catalog.description or 'N/A'}") 185 | 186 | # Creating a collections dataframe 187 | try: 188 | collections_df = collectCollectionsInfo(root_catalog) 189 | except: 190 | st.error(''' 191 | ⛔️ Ooops, something went wrong that is not covered by PySTAC-client library. 192 | 193 | Most likely the problem based on not compatible STAC version. 194 | Feel free to ping me on [Twitter](https://twitter.com/MykolaKozyr) or [LinkedIn](https://www.linkedin.com/in/mykolakozyr/) to discuss details. It's very possible I missed something. 195 | ''') 196 | st.stop() 197 | 198 | if len(collections_df) == 0: 199 | st.warning(''' 200 | ⚠️ Ooops, looks like catalog does not have collections 🤷‍♂️. 201 | 202 | Feel free to ping me on [Twitter](https://twitter.com/MykolaKozyr) or [LinkedIn](https://www.linkedin.com/in/mykolakozyr/) to discuss details. It's very possible I missed something. 203 | ''') 204 | st.stop() 205 | collections_df = pd.DataFrame(collections_df) 206 | st.sidebar.write(f"Number of collections: {collections_df.shape[0]}") 207 | st.sidebar.markdown("---") 208 | collections_df.columns=['id', 'title', 'description'] 209 | 210 | # Selecting specific collection 211 | option = selectCollection(collections_df) 212 | if option: 213 | collection = root_catalog.get_child(option) 214 | 215 | # Creating items dataframe 216 | limit_items = st.sidebar.slider('Please specify number of STAC items to return.', min_value=1, max_value=25000, value=1000,) 217 | w1 = KeplerGl(height=800) 218 | if st.sidebar.button('Visualize the STAC Collection!'): 219 | items_gdf = collectItemsInfo(collection, limit_items) 220 | st.sidebar.write(f"Number of items: {items_gdf.shape[0]}") 221 | 222 | # Creating KeplerGL map 223 | w1.add_data(data=items_gdf, name='staccollection') 224 | w1.config = config 225 | 226 | # Visualize in Streamlit 227 | keplergl_static(w1) 228 | else: 229 | st.stop() 230 | else: 231 | st.stop() 232 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------