Home.py

import streamlit as st
import pandas as pd
import requests
import json

from utils.func import is_valid_json
from utils.func import remove_sup_sub_tags
from utils.func import fetch_mineral_data
from utils.func import filter_results_by_shortcode



header = 'An Overview of the Most Important Minerals'
st.set_page_config(
    page_title= header,
    page_icon=':rock:',
)

# text and information 

subheader_1='Welcome!👋'
subheader_2='Select the mineral and the information you want to get'
subheader_3='Request the Information'
subheader_4='Results:'
subheader_5='Download Results'
info_1 =('This app can be used to get information about the most important minerals in geoscience. '
        'The information provided here is requested from Mindat.org and only information for minerals '
        'which are approved by the International Mineralogical Association (IMA) are available. '
        'If you want to explore more '
        'information about minerals, you can visit [Mindat.org](https://www.mindat.org).')
info_2 ='If you want, you can download the displayed results for the chosen mineral as a JSON file.'
label_selectbox_1='Which Mineral do you want to look at?'
label_selectbox_2='Select fields:'
label_button_1='Start requesting information!'
label_button_2='Download selected information as JSON'

# display Header and introduction
st.header(header)
st.divider()
st.subheader(subheader_1)
st.markdown(info_1)

tab1, tab2 = st.tabs(["💎 minerals", "🔎 short codes"])

with tab1:
    header = 'Get Information about a specific mineral'
    subheader_1='Select the mineral and the information you want to get:'
    subheader_2='Request the Information'
    subheader_3='Results:'
    subheader_4='Download Results as JSON:'
    info_1 =('Here you can select some of the most important minerals in Geosience and get some Information about them for example their formulas, shortcodes, crystalsystems and main elements.' 
             ' The shortcode and formula for the minerals are the IMA-shortcode and the IMA-formula. '
            'Your selected information will be requested from Mindat.org .')
    info_2 ='If you want, you can download the displayed results for the chosen mineral as a JSON file.'
    label_selectbox_1='Select minerals:'
    label_selectbox_2='Select fields:'
    label_ckeckbox='Show the Mindat.org links for the selected minerals'
    label_button='Download selected information as JSON'

    st.header(header)
    st.markdown(info_1)
    st.divider()
    st.subheader(subheader_1)

######################################################### Parameters API request ######################################################################

    key = st.secrets["api_key"]
    MINDAT_API_URL = "https://api.mindat.org"
    if not key:
        raise ValueError("No API-Key found.")

######################################################### Important minerals and field mapping ###########################################################

    url_1 = "https://raw.githubusercontent.com/LaraFriedrichs/Test_Auswahl_Minerale/main/data/important_minerals.csv"
    url_2 = "https://raw.githubusercontent.com/LaraFriedrichs/Test_Auswahl_Minerale/main/data/fieldsshort.json"
    url_3 = "https://raw.githubusercontent.com/LaraFriedrichs/Test_Auswahl_Minerale/main/data/fieldsall.json"

    important_minerals = pd.read_csv(url_1)

    fields_short = requests.get(url_2)
    field_mapping = fields_short.json()

    fields_all = requests.get(url_3)
    field_mapping_all = fields_all.json()

    mapped_fields=list(field_mapping.keys())
    mapped_fields_results = {v: k for k, v in field_mapping.items()}

    mapped_fields_all=list(field_mapping_all.keys())
    mapped_fields_results_all = {v: k for k, v in field_mapping_all.items()}

########################################## User Input ##########################################################################

    col1, col2 = st.columns(2)

# select minerals
    with col1:
        minerals=st.multiselect(label_selectbox_1,important_minerals, help='Here you can select the minerals for which you want to get Information. You can select more than one mineral!')
        
# select fields
    with col2:
        multiselect = st.multiselect(label_selectbox_2,mapped_fields,help='This selection can be used to select fields by hand. Here you can choose from the most relevant properties!')

    options_select=['Use selected fields','Select all','Use all fields from Mindat.org/geomaterials']
    radio_selection = st.radio('Select which fields schould be requested:', options=options_select,help='Here you have to select the fields which should be requested. If you choose "Use selected fields" your selected fields from above will be used. If you choose "Select all" all fields that are possible to select above are requested. If you use this you will get the most relevant Information, but if you want to get more Information you can choose "Use all fields from Mindat.org/geomaterials", if you do so all fields will be requested from Mindat.org/geomaterials!')

# checkbox link 

    show_link=st.checkbox(label_ckeckbox,help='If you want you can add the Mindat.org links for the minerals to the results.')

    if radio_selection == 'Select all':
        selection = field_mapping  
        api_fields = [field_mapping.get(field) for field in selection]
        api_fields.insert(0, 'name')
        api_fields.insert(1, 'id')
        api_fields.insert(2, 'ima_formula')
    elif radio_selection == 'Use all fields from Mindat.org/geomaterials':
        selection = field_mapping_all  
        api_fields = [field_mapping_all.get(field) for field in selection]
        api_fields.insert(0, 'name')
        api_fields.insert(1, 'id')
        api_fields.insert(2, 'ima_formula')
    elif radio_selection == 'Use selected fields':
        selection = multiselect
        api_fields = [field_mapping.get(field) for field in selection]
        api_fields.insert(0, 'name')
        api_fields.insert(1, 'id')
        api_fields.insert(2, 'ima_formula')
    else:
        st.write("Please select an option to proceed.")
   
############################################################ API Request ########################################################

    all_results = []

    for mineral in minerals:
    
        params = {"name": mineral, "ima_status": "APPROVED", "format": "json"}
        headers = {'Authorization': 'Token ' + key}

        try:
            response = requests.get(MINDAT_API_URL + "/geomaterials/", params=params, headers=headers)
            while response.status_code == 200 and is_valid_json(response):
                response_data = response.json()
                result_data = response_data.get("results", [])
                all_results.extend(result_data)

                next_url = response_data.get("next")
                if not next_url:
                    break
                response = requests.get(next_url, headers=headers)
        except requests.RequestException as e:
            st.error(f"Request failed for {mineral}: {e}")

        if all_results:
            filtered_results = []
        # Filter the results to include only the selected fields
            for result in all_results:
                filtered_result = {mapped_fields_results_all[field] : result.get(field) for field in api_fields}
                filtered_results.append(filtered_result)

    else:
        st.write("")

########################## modify and display results ################################################################

    if all_results: 
        st.divider()
        st.subheader(subheader_3)
        df = pd.DataFrame.from_dict(pd.json_normalize(filtered_results), orient='columns')
        new_formulas=[]
        mindat_links=[]
        corrected_ids=[]
        for formula in df["Formula (IMA)"]:
            new_formula=remove_sup_sub_tags(formula)
            new_formulas.append(new_formula)
        for id in df["ID"]:
            mindat_link='https://www.mindat.org/min-'+str(id)+'.html'
            mindat_links.append(mindat_link)
            corrected_id=str(id)
            corrected_ids.append(corrected_id)
        if radio_selection=='Use all fields from Mindat.org/geomaterials':
            new_formulas=[]
            for formula in df["Mindat Formula"]:
                new_formula=remove_sup_sub_tags(formula)
                new_formulas.append(new_formula)
            df["Mindat Formula"]=new_formulas

        df["Formula (IMA)"]=new_formulas
        df["ID"]=corrected_ids
        if show_link==True:
            df["View Mineral on Mindat.org"]=mindat_links
        st.dataframe(
        df,
        column_config={
        "View Mineral on Mindat.org": st.column_config.LinkColumn("View Mineral on Mindat.org")
        },
        hide_index=True,
        )

############################################# download results ################################################################
        st.divider()
        st.subheader(subheader_4)
        st.write(info_2)
        st.download_button(
            label=label_button, use_container_width=True,
            data=json.dumps(filtered_results, indent=4),
            file_name='mineral_data.json',
            mime='application/json'
        )
################################################ Tab 2 ######################################################################## 
with tab2:
################################################# Text ####################################################################

    st.header("Minerals and their Short Codes")
    st.markdown("""Here you can look up some of the most important minerals in Geosience by using their shortcode.
        The information provided here is requested from mindat.org and only information for minerals 
        which are approved by the International Mineralogical Association (IMA) are available.
        The shortcode is the IMA-shortcode.""")

################################################# Multiselect ###########################################################

    url_1 = "https://raw.githubusercontent.com/LaraFriedrichs/Test_Auswahl_Minerale/main/data/shortcodes_important_minerals.csv"
    shortcodes_important_minerals = pd.read_csv(url_1)
    st.divider()
    st.subheader("Enter a shortcode:")

    shortcodes = st.multiselect("", shortcodes_important_minerals)

############################################## read Json data ########################################################################

    filePath = "https://raw.githubusercontent.com/LaraFriedrichs/Test_Auswahl_Minerale/refs/heads/main/data/mineral_results.json"

    mineral_results = requests.get(filePath)

    json_data = mineral_results.json()

    #st.write(json_data)

########################################## mapping shortcodes and names ###############################################################

    name_shortcode_mapping={}

    # Über die Einträge in der JSON-Datei iterieren
    for mineral_info in json_data:
        name = mineral_info.get('name')
        shortcode_ima = mineral_info.get('shortcode_ima')
        aboutname = mineral_info.get('aboutname')

        # Nur Einträge hinzufügen, die sowohl 'name' als auch 'shortcode_ima' enthalten
        if name and shortcode_ima:
           name_shortcode_mapping[shortcode_ima] = [name,aboutname]

########################################## display results ######################################################################

    for short_code in shortcodes:
        data = name_shortcode_mapping.get(short_code, "Shortcode not found.")
        name = data[0]
        aboutname = data[1]
        with st.expander(short_code, expanded=True):
            st.write(f"{short_code} is the IMA shortcode for {name}.")
            st.write(aboutname)

#############################################################################################################################