Merge pull request #514 from agoenergy/release_1.0

Release 1.0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.9.2
+current_version = 1.0.0
 commit = True
 tag = True
 

.github/workflows/publish.yaml

@@ -23,4 +23,4 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           push: true
-          tags: wingechr/ptx-boa:0.9.2
+          tags: wingechr/ptx-boa:1.0.0

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG.md
 
+## 1.0.0 (2024-06-22)
+
+- launch release
+- cosmetic changes
+
 ## 0.9.2 (2024-06-21)
 
 - pre-launch release

Dockerfile

@@ -1,5 +1,5 @@
 FROM python:3.10-slim
-LABEL version="0.9.2"
+LABEL version="1.0.0"
 
 RUN apt-get update
 RUN apt-get install -y git

README.md

@@ -68,7 +68,7 @@ scp -r ptxboa2:ptx-boa_offline_optimization/optimization_cache/* .
 # connect to server
 ssh ptxboa
 # pull latest image from dockerhub
-VERSION=0.9.2
+VERSION=1.0.0
 docker pull wingechr/ptx-boa:$VERSION
 # stop and delete the currently running container "app"
 docker stop app

app/ptxboa_functions.py

@@ -139,7 +139,9 @@ def calculate_results_list(
                 settings.update({"secproc_co2": None})
 
         # for all regions but the selected one, use Wind-PV-hybrid RE source:
-        if settings["region"] != st.session_state["region"]:
+        if settings["region"] == st.session_state["region"]:
+            settings["res_gen"] = st.session_state["res_gen"]
+        else:
             settings["res_gen"] = "Wind-PV-Hybrid"
 
         # consider user data in optimization only for parameter set in session state

app/tab_info.py

@@ -4,7 +4,7 @@
 
 from app.ptxboa_functions import read_markdown_file
 
-__version__ = "0.9.2"
+__version__ = "1.0.0"
 
 
 def content_info():

app/tab_input_data.py

@@ -69,6 +69,8 @@ def content_input_data(api: PtxboaAPI) -> None:
             st.plotly_chart(fig, use_container_width=True)
 
         with st.expander("**Data**"):
+            if data_selection == "full load hours":
+                st.caption(read_markdown_file("md/helptext_flh.md"))
             df = display_and_edit_input_data(
                 api,
                 data_type=data_selection,
@@ -98,6 +100,12 @@ def content_input_data(api: PtxboaAPI) -> None:
     with st.container(border=True):
         st.subheader("Global data")
         with st.expander("**Electricity generation**"):
+            st.caption(
+                (
+                    "CAPEX and full load hours of renewables"
+                    " are region specific and are shown above."
+                )
+            )
             display_and_edit_input_data(
                 api,
                 data_type="electricity_generation",
@@ -177,6 +185,10 @@ def content_input_data(api: PtxboaAPI) -> None:
                 key="input_data_dac_and_desalination",
             )
         with st.expander("**Specific costs for materials and energy carriers**"):
+            st.caption(
+                read_markdown_file("md/helptext_columns_specific_costs.md"),
+                unsafe_allow_html=True,
+            )
             display_and_edit_input_data(
                 api,
                 data_type="specific_costs",

app/tab_market_scanning.py

@@ -283,7 +283,17 @@ def content_market_scanning(api: PtxboaAPI, cd: dict) -> None:
 
         st.plotly_chart(fig, use_container_width=True)
 
+        st.caption(
+            (
+                "Notes:\n"
+                "- For EU, trasportation distance to France is used.\n"
+                "- Countries are not plotted if either distance or demand data"
+                " is missing."
+            )
+        )
+
         with st.expander("**Data**"):
             st.dataframe(df, use_container_width=True)
+            st.caption("Note: For EU, trasportation distance to France is used.")
             fn = "market_scanning_target_countries"
             prepare_and_download_df_as_excel(df, filename=fn)

md/helptext_flh.md

@@ -0,0 +1,4 @@
+- Realized full load hours may be lower due to curtailment.
+- For Wind-PV-Hybrid sites, combined full load hours are estimated for a fixed capacity relation of Wind Onshore and PV plants. The cost efficient capacity share is determined by optimization, which will also affect full load hours.
+- Full load hours of electrolyzer and derivate production are not shown because they are determined by optimization and vary between regions, generation sites, and process chains.
+- For the selected region and settings full load hours of all processes are shown in the **Optimization** tab.

ptxboa_streamlit.py

@@ -6,7 +6,7 @@
 >>> streamlit run  ptxboa_streamlit.py
 """
 
-__version__ = "0.9.2"
+__version__ = "1.0.0"
 
 import logging
 
@@ -91,13 +91,6 @@
 
 st.title("PtX Business Opportunity Analyser")
 
-with st.container():
-    st.error(
-        f"**Draft version ({__version__})!** This app is under development."
-        " Results are preliminary, and there may be bugs or unexpected behaviour."
-        " Please do not cite."
-    )
-
 with st.container():
     if st.session_state["edit_input_data"]:
         st.info("Data editing mode **ON**")