tabs/tab0_welcome.py

import streamlit as st
from config.config import CO2_UNIT
from utils.ui_helpers import show_bar

def render_tab():
    """Render the Welcome tab with a step-by-step guide to using the tool.

    Returns:
        None
    """
    st.markdown('<h1 class="crra-heading">Welcome!</h1>', unsafe_allow_html=True)
    show_bar()

    st.markdown("""
    <div class='custom-corps'>
    This tool helps project teams working on a CRRA and the CDR-curious explore how to optimise carbon dioxide removal portfolios by adjusting resource usage and constraints.
    </div>
    <br>
    """, unsafe_allow_html=True)

    st.warning("""
    While the tool offers multiple customisation parameters and allows you to iterate on the results, it can never capture the full nuance and specificity of the resources and their availability in every single country.\n
    The results of the optimisation tool must therefore not be considered as final or complete. Users should use the results as a basis and refine the final CDR portfolios manually to account for the information/context not captured in the model.
    """,
    icon=":material/warning:",
    title="Disclaimer")

    st.markdown(f"""
    <div class='custom-corps'>
    <h3 class="wt wt-1">Required:</h3>
    <ol>
        <li><b>Resource inputs</b>: provide the total available quantities of resources for 1 year.</li>
    </ol>

    <h3 class="wt wt-2">Optional:</h3>
    <ol start="2">
        <li><b>Method constraints</b>: select which carbon removal methods are active and set their <b>maximum deployment cap</b> (as % of its total potential or absolute value in {CO2_UNIT}/yr).</li>
        <li><b>Resource efficiency coefficients</b>: adjust the resource usage for each method.</li>
    </ol>

    <h3 class="wt wt-3">Outputs:</h3>
    <ol start="4">
        <li><b>Portfolio generation</b>: run the optimisation to find the best portfolio: how much CO₂ is removed, what methods are used, and in what proportions.</li>
    </ol>

    <h3 class="wt wt-4">Explore:</h3>
    <ol start="5">
        <li><b>Sensitivity analysis</b>: analyse how changes in method caps or resource availability affect the portfolio.</li>
        <li><b>Scenario comparison</b>: compare different scenarios based on the optimisation results.</li>
    </ol>

    <p class="wt-cta"><span class="crra-hl">Let’s get started!</span> Use the side tabs to navigate through the sections.</p>
    </div>
    """, unsafe_allow_html=True)

    if st.button("Resource inputs →", key="btn-nav-next-welcome", type="primary", help="Start by setting the resources available for your CRRA."):
        st.session_state["_navigate_to"] = "Resource inputs"
        st.rerun()