diff --git a/app/ptxboa_functions.py b/app/ptxboa_functions.py index b921b807..ba9eedce 100644 --- a/app/ptxboa_functions.py +++ b/app/ptxboa_functions.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- """Utility functions for streamlit app.""" +from pathlib import Path from typing import Literal import pandas as pd @@ -622,3 +623,8 @@ def move_to_tab(tab_name): old_tab_key_nb = int(st.session_state["tab_key"].replace("tab_key_", "")) st.session_state["tab_key"] = f"tab_key_{old_tab_key_nb + 1}" st.session_state[st.session_state["tab_key"]] = tab_name + + +def read_markdown_file(markdown_file: str) -> str: + """Import markdown file as string.""" + return Path(markdown_file).read_text(encoding="UTF-8") diff --git a/app/tab_info.py b/app/tab_info.py index 1d99884c..704b72c5 100644 --- a/app/tab_info.py +++ b/app/tab_info.py @@ -2,38 +2,13 @@ """Info tab.""" import streamlit as st +from app.ptxboa_functions import read_markdown_file + def content_info(): with st.container(border=True): - st.markdown("### What functionalities does this tool provide to users? ") - st.markdown( - """ - - Get an impression of **total costs of delivered hydrogen and various derivative - molecules** of your country of interest to a potential demand country - - Analyze the **cost components** of flexibly selectable process chains - and production routes - - **Compare costs** between various production pathways, supply and demand countries - on a global scale - - Access comprehensive **additional context information** on relevant aspects - for PTX trade such as potential sustainability issues and certification - - If required, **adjust data points** according to your own level of knowledge - """, - unsafe_allow_html=True, - ) + st.markdown(read_markdown_file("static/info_intro.md")) - st.markdown("### On the level of detail") - st.markdown( - """ - The tool calculates **simple levelized costs of hydrogen and derivatives** - at screening/pre-feasbility level. - The table below gives an overview on different levels - of cost/price approximations. - In this overview, the tool locates in first level which aims at providing - high-level analyses at pre-feasibility level to start the discussion. - It does not show realized project costs or hydrogen and derivative prices. - - """ - ) st.image("static/costs_of_hydrogen.png", width=800) with st.container(border=True): @@ -66,47 +41,7 @@ def content_info(): ) with st.container(border=True): - st.markdown("#### Disclaimer") - st.markdown( - """ - The PTX BOA uses technical reports published by third parties. - The authors of the tool and Agora Energiewende trust but do not guarantee - the accuracy and completeness of the information provided by them. - - All rights reserved to Öko-Institut and Agora Energiewende. - The use of the methods and results are only authorised - in case Öko-institut and Agora Energiewende is properly cited. - """ - ) - - st.markdown("#### Licensing and quotation") - st.markdown( - """ - This tool is licensed under the Creative Commons CC-BY-SA license - (https://creativecommons.org/licenses/by-sa/4.0/). - - Please cite it as: Oeko-Institut, Agora Energiewende & Agora Industry (2023): - PTX Business Opportunity Analyser - https://ptx-boa.streamlit.app/ - """ - ) - st.markdown("#### Source code and contribution") - st.markdown( - """ - We strongly welcome anyone interested in contributing to this project. - If you would like to file a bug, make a feature request - or make a contribution, please check out our Github repository: - https://github.com/agoenergy/ptx-boa - """ - ) - - st.markdown("#### Additional resources") - st.markdown( - """ - Visit our website for data documentation, additional resources and updates: - https://www.agora-energiewende.de/en/publications/business-opportunity-analyser-boa - """ - ) + st.markdown(read_markdown_file("static/info_disclaimer.md")) with st.container(border=True): c1, c2, c3 = st.columns(3) diff --git a/static/info_disclaimer.md b/static/info_disclaimer.md new file mode 100644 index 00000000..f57d17d1 --- /dev/null +++ b/static/info_disclaimer.md @@ -0,0 +1,30 @@ +#### Disclaimer + +The PTX BOA uses technical reports published by third parties. +The authors of the tool and Agora Energiewende trust but do not guarantee +the accuracy and completeness of the information provided by them. + +All rights reserved to Öko-Institut and Agora Energiewende. +The use of the methods and results are only authorised +in case Öko-institut and Agora Energiewende is properly cited. + +#### Licensing and quotation + +This tool is licensed under the Creative Commons CC-BY-SA license +(). + +Please cite it as: Oeko-Institut, Agora Energiewende & Agora Industry (2023): +PTX Business Opportunity Analyser + + +#### Source code and contribution + +We strongly welcome anyone interested in contributing to this project. +If you would like to file a bug, make a feature request +or make a contribution, please check out our Github repository: + + +#### Additional resources + +Visit our website for data documentation, additional resources and updates: + diff --git a/static/info_intro.md b/static/info_intro.md new file mode 100644 index 00000000..65ff9c8a --- /dev/null +++ b/static/info_intro.md @@ -0,0 +1,14 @@ +### What functionalities does this tool provide to users? + +- Get an impression of **total costs of delivered hydrogen and various derivative molecules** of your country of interest to a potential demand country +- Analyze the **cost components** of flexibly selectable process chains and production routes +- **Compare costs** between various production pathways, supply and demand countries on a global scale +- Access comprehensive **additional context information** on relevant aspects for PTX trade such as potential sustainability issues and certification +- If required, **adjust data points** according to your own level of knowledge + +### On the level of detail + +The tool calculates **simple levelized costs of hydrogen and derivatives** at screening/pre-feasbility level. +The table below (Agora & Umlaut 2023) gives an overview on different levels of cost/price approximations. +In this overview, the tool locates in first level which aims at providing high-level analyses at pre-feasibility level to start the discussion. +It does not show realized project costs or hydrogen and derivative prices.