New UKCEH logo, add user licence, warmup function speed up API

.gitignore

@@ -1,3 +1,5 @@
 .env
 .streamlit/secrets.toml
-venv
+venv
+
+rsconnect-python/

app.py

@@ -4,6 +4,7 @@ import json
 import os
 from dotenv import load_dotenv
 from streamlit_js_eval import get_geolocation
+import threading
 
 # Load environment variables from .env file
 load_dotenv()
@@ -12,31 +13,37 @@ load_dotenv()
 api_key = os.getenv("API_KEY",None)
 base_url = os.getenv("API_URL",None)
 url = f"{base_url}/predict"  # Adjust if upload endpoint is different
+warm_up_url = f"{base_url}/warmup"
 
 headers = {
     "Authorization": f"Key {api_key}",
     "accept": "application/json"
 }
 
+# Warmup function this runs in a separate thread to avoid blocking the main app and to ensure the API is ready (model loaded from cache) when the user makes a request
+def warmup():
+    print("Warming up the API...")
+    resp = requests.get(warm_up_url, headers=headers)
+    print("Warmup response:", resp.status_code)
+@st.cache_resource
+def start_warmup_thread():
+    thread = threading.Thread(target=warmup, daemon=True)
+    thread.start()
+    return "warmup_started"
+start_warmup_thread()
+
+
 st.set_page_config(page_title="AI-Hab Habitat Classifier", page_icon="static/img/ai-hab-logo-transparent.png", layout="centered")
-st.title("AI-Hab Habitat Classifier")
 
-#tab1, tab2, tab3 = st.tabs(["Location", "Image", "Prediction"])
+st.title("AI-Hab Habitat Classifier")
 
-#with tab1:
-    # st.write("## Location")
-location = get_geolocation()
-    # if location is not None:
-    #     st.map([{"lat": location['coords']['latitude'], "lon": location['coords']['longitude']}])
-    # else:
-    #     st.warning("Location is not enabled.")
+st.markdown("AI-Hab is a habitat classification model developed by the [Laboratory of Vision Engineering](https://www.visioneng.org.uk/) at the [University of Lincoln](https://www.lincoln.ac.uk/) and the [UK Centre for Ecology & Hydrology](https://www.ceh.ac.uk/). It is based on the [UKHab](https://www.ukhab.org/) Habitat Classification system and uses computer vision to classify habitats from images. The model is trained on images from the [UKCEH Contryside Survey](https://www.ceh.ac.uk/our-science/projects/countryside-survey).") 
 
 # Take photo or upload
-#with tab2:
 st.write("## Capture or Upload Image")
 img = st.camera_input("Take a photo of the habitat") or st.file_uploader("Or upload a photo", type=["png", "jpg", "jpeg"])
+location = get_geolocation()
 
-#with tab3:
 if img:
     # Send to API
     with st.spinner("Analyzing habitat..."):
@@ -94,5 +101,21 @@ with col1:
 with col2:
     st.image("static/img/University-of-Lincoln.png")
 
-st.write("AI-Hab is a habitat classification model developed by the UK Centre for Ecology & Hydrology and the University of Lincoln. It is based on the UKHab Habitat Classification system and uses computer vision to classify habitats from images.")       
-        
+st.markdown("Read the preprint: [Habitat Classification from Ground-Level Imagery Using Deep Neural Networks](https://arxiv.org/abs/2507.04017).")      
+st.markdown("View the code to this demonstrator app on [GitHub](https://github.com/NERC-CEH/aihab-streamlit-demo)")
+
+# Load licence markdown (cached)
+@st.cache_data
+def load_licence():
+    with open("static/licence/licence.md", "r", encoding="utf-8") as f:
+        return f.read()
+
+# Define a dialog using the new decorator
+@st.dialog("Terms and Conditions for AI-Hab API access")
+def licence_dialog():
+    st.markdown(load_licence())
+    st.button("Close", on_click=lambda: st.session_state.update(show_dialog=False))
+
+# Create a button to open the dialog
+if st.button("View Terms and Conditions"):
+    licence_dialog()

static/licence/licence.md

@@ -0,0 +1,105 @@
+Licence for API Access to AI-HAB API Available from the UK Centre for Ecology & Hydrology 
+
+Your use of information provided by UKCEH is at your own risk. Please read any warnings given about the limitations of the information. 
+
+## 1 DEFINITIONS 
+
+“the API” means the application programming interface providing access to the Data and available here: .. 
+
+"Data" means information on habitat classification returned to you. 
+
+“Evaluation Use” means to access and use the API and Data for the purposes of internal assessment purposes only, without the right to commercialise, redistribute, or publicly disclose the Data or any derivative works created from it.  
+
+"Non-Commercial" means use of the API or Data that does not involve making a financial gain. 
+
+"Licensor" means Centre for Ecology & Hydrology (CEH), a component part of the Natural Environment Research Council (NERC). 
+
+"You" or "Licensee" means either (a) the individual accepting the terms of this licence on their own behalf, or (b) the corporate entity or partnership on whose behalf those terms are accepted. 
+
+## 2 GRANT OF LICENCE 
+
+The Licensor grants to The Licensee a non-exclusive, non-transferable, royalty free licence to use the API and Data providing the use falls within the permitted use set out below and for no other purpose. Your licence does not permit You to sub-license the API or the Data for any purpose. 
+
+## 3 PERMITTED USE 
+
+3.1 You may use the API and Data for Evaluation Use which is Non-commercial in nature. 
+
+4 RESTRICTIONS ON USE 
+
+4.1 You may not rent, lease, sell, sublicense or otherwise distribute the Data or the API to a third party. 
+
+4.2 You may not assign or transfer this Licence Agreement or any rights under it. 
+
+4.3 You may not use the API in any way that damages the performance or security of the API and You understand and agree that the Licensor may if it deems your use of the API to damage the performance or security of the API disable your access to the API and terminate this licence without notice.  
+
+ 
+
+## 5 UNDERTAKINGS 
+
+5.1 You undertake to store the Data in such a way that they can be accessed and used only in accordance with the terms of the Licence Agreement. 
+
+5.2 You undertake to ensure that all persons to whom You make the Data accessible are aware of the limitations placed upon the use of the Data by this Licence Agreement, and ensure that such persons comply with all the restrictions placed upon the use of and access to the Data as set out in this Licence Agreement. 
+
+5.3 You agree to take full responsibility for identifying whether the API is fit for any use that You make of it and You understand and agree that the Licensor will not be responsible for providing support in relation to your use of the API or in relation to any Derived Services. 
+
+## 6 OWNERSHIP 
+
+6.1 The Licensor or its third party licensors retain ownership of the Data and related documentation, which are also protected under applicable copyright and database laws. 
+
+## 7 WARRANTY 
+
+7.1 Data may have been transcribed from analogue to digital format, or may have been acquired by means of automated techniques. Although such processes are subjected to quality control to ensure reliability where possible, some data may have been processed without human intervention and may as a consequence contain undetected errors. 
+
+7.2 The Licensor gives no warranty as to the accuracy or completeness of the Data, including in the form in which they are cached or downloaded to your computer, as they may be affected by on-line conditions over which the Licensor has no control. 
+
+7.3 The data, information and related records supplied by the Licensor should not be taken as a substitute for specialist interpretations, and /or professional advice. You must seek professional advice before making technical interpretations on the basis of the materials provided. 
+
+7.4 The Licensor does not warrant that the API or the Data will meet your requirements or that the API’s operation or the operation of any Derived Services will be uninterrupted or error free. This licence agreement does not affect your statutory rights. 
+
+7.5 The Licensor does not warrant that the API or Data will remain unchanged in terms of content or structure. 
+
+## 8 LIABILITY 
+
+8.1 All guarantees, representations and warranties of any kind, whether express or implied, including, without limitation, the implied warranties of satisfactory quality, merchantability and fitness for a particular purpose or ability to achieve a particular result are hereby excluded, so far as such exclusion or disclaimer is permitted under the applicable law. You assume the entire risk as to the quality and performance of the API and Data. Should the API or Data prove defective, You (and not the Licensor) assume the entire cost of all necessary servicing or correction. 
+
+8.2 In no event shall the Licensor be liable for any damages, including loss of business, loss of opportunity, loss of data, loss of profits or for any other indirect or consequential loss or damage whatsoever arising out of the use of or inability to use the API or Data even if the Licensor has been made aware of the possibility of such damages. 
+
+8.3 The Licensor accepts no liability for any loss or damage which may be caused by the API or Data and the Licensee is expected to operate suitable anti-virus software before loading it into its computer system. The Licensee also being responsible for ensuring that the form of the information received is compatible with its computer system and any other data with which the information is to be used. 
+
+8.4 Nothing in this Licence Agreement shall exclude or limit the liability of the Licensor or the Licensee for fraudulent misrepresentation or for death or personal injury resulting from the negligence of the Licensor or the Licensee. 
+
+## 9 DATA PROTECTION 
+
+9.1 The Licensor will treat any personal information provided or obtained, in accordance with the provisions of the Data Protection Act of 2018. 
+
+9.2 Any personal information provided or obtained shall be used only for the purposes of providing the Licensee with access to the API and Data, for communication relating to updates and amendments, relating to CEH products or services, and for system administration of the web server, unless otherwise agreed by the Licensee. 
+
+9.3 The Licensor will on request, delete or remove any personal information held from a Licensee. 
+
+## 10 TERMINATION 
+
+10.1 The Licensor may terminate this Licence Agreement and disable the Licensee’s access to the API without notice. 
+
+10.2 The Licence Agreement will terminate automatically if any of its terms are breached by the Licensee. 
+
+10.3 Upon termination all rights You have to use the API and Data will cease and You must destroy or delete the Data (including cashed, partial or modified versions and datasets derived from the Data) and all copies from all storage media in your control. 
+
+Clauses 1, 7, 8, 10.3 and 13 will survive termination of this agreement. 
+
+## 11 SEVERABILITY 
+
+If any provision of this licence agreement is held invalid, illegal or unenforceable for any reason by any court of competent jurisdiction such provision shall be severed and the remainder of the provisions hereof shall continue in full force and effect as if this licence agreement had been agreed with the invalid illegal or unenforceable provision eliminated. 
+
+## 12 ENTIRE AGREEMENT 
+
+This licence agreement contains the entire agreement between parties relating to the subject matter and supersedes all proposals, representations, understandings and prior agreements, whether oral or written, and all other communications between parties relating to that subject matter. 
+
+## 13 GOVERNING LAW AND JURISDICTION 
+
+This agreement shall be governed by and construed in accordance with English law and the parties submit to the exclusive jurisdiction of the English courts. 
+
+## 14 CONTRACTS (RIGHTS OF THIRD PARTIES) ACT 1999 
+
+A person who is not party to this Agreement has no right under the Contracts (Rights of Third Parties) Act 1999 to enforce any terms of this Agreement, but this does not affect any right or remedy of a third party which exists or is available apart from that Act. 
+
+