release 0.6.0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.5.0
+current_version = 0.6.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.5.0
+          tags: wingechr/ptx-boa:0.6.0

.streamlit/config.toml

@@ -6,7 +6,7 @@
     font="sans serif"
 
 [logger]
-    level="WARNING"
+    level="INFO"
 
 [browser]
     gatherUsageStats = false

Dockerfile

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

README.md

@@ -10,15 +10,15 @@ After cloning the repository, create a virtual python environment
 in a subdirectory `.env` and activate it:
 
 ```bash
-$ python -m venv .\.env
-$ .env\Scripts\activate.bat
+python -m venv .\.env
+.env\Scripts\activate.bat
 ```
 
 Install the necessary dependencies:
 
 ```bash
-$ python -m pip install --upgrade pip
-$ pip install -r requirements-dev.txt
+python -m pip install --upgrade pip
+pip install -r requirements-dev.txt
 ```
 
 The code is autoformatted and checked with [pre-commit](https://pre-commit.com/).
@@ -43,6 +43,13 @@ In order to run the tests locally run [pytest](https://pytest.org) in the root d
 pytest
 ```
 
+### Download optimization cache for local development
+
+````bash
+cd ptxboa\cache
+scp -r ptxboa2:ptx-boa_offline_optimization/optimization_cache/* .
+````
+
 ## Release Procedure
 
 - merge all relevant branches into develop
@@ -61,7 +68,7 @@ pytest
 # connect to server
 ssh ptxboa
 # pull latest image from dockerhub
-VERSION=0.5.0
+VERSION=0.6.0
 docker pull wingechr/ptx-boa:$VERSION
 # stop and delete the currently running container "app"
 docker stop app

app/layout_elements.py

@@ -165,6 +165,57 @@ def display_footer():
             st.image("img/PtX-Hub_Logo_international_612x306.png")
 
 
+def _form_data_editor(
+    key,
+    df,
+    df_orig,
+    index,
+    columns,
+    missing_index_name,
+    missing_index_value,
+    column_config,
+):
+    if f"{key}_number" not in st.session_state:
+        st.session_state[f"{key}_number"] = 0
+    editor_key = f"{key}_{st.session_state[f'{key}_number']}"
+
+    with st.form(key=f"{key}_form", border=False):
+        st.info(
+            (
+                "You can edit data directly in the table. When done, click the "
+                "**Apply changes** button below to rerun calculations."
+            )
+        )
+
+        st.form_submit_button(
+            "Apply changes",
+            type="primary",
+            on_click=register_user_changes,
+            kwargs={
+                "missing_index_name": missing_index_name,
+                "missing_index_value": missing_index_value,
+                "index": index,
+                "columns": columns,
+                "values": "value",
+                "df_tab": df,
+                "df_orig": df_orig,
+                "key": key,
+                "editor_key": editor_key,
+            },
+        )
+
+        df = st.data_editor(
+            df,
+            use_container_width=True,
+            key=editor_key,
+            num_rows="fixed",
+            disabled=[index],
+            column_config=column_config,
+        )
+
+    return df
+
+
 def display_and_edit_input_data(
     api: PtxboaAPI,
     data_type: Literal[
@@ -243,9 +294,9 @@ def display_and_edit_input_data(
         missing_index_name = "source_region_code"
         missing_index_value = None
         column_config = {
-            "CAPEX": st.column_config.NumberColumn(format="%.2e USD/kg", min_value=0),
+            "CAPEX": st.column_config.NumberColumn(format="%.5f USD/kg", min_value=0),
             "OPEX (fix)": st.column_config.NumberColumn(
-                format="%.2e USD/kg", min_value=0
+                format="%.5f USD/kg", min_value=0
             ),
             "efficiency": st.column_config.NumberColumn(
                 format="%.2f", min_value=0, max_value=1
@@ -263,7 +314,9 @@ def display_and_edit_input_data(
         missing_index_name = "parameter_code"
         missing_index_value = "interest rate"
         column_config = {
-            c: st.column_config.NumberColumn(format="%.3f", min_value=0, max_value=1)
+            c: st.column_config.NumberColumn(
+                format="%.2f %%", min_value=0, max_value=100
+            )
             for c in df.columns
         }
 
@@ -307,43 +360,24 @@ def display_and_edit_input_data(
 
     # if editing is enabled, store modifications in session_state:
     if st.session_state["edit_input_data"]:
-        if f"{key}_number" not in st.session_state:
-            st.session_state[f"{key}_number"] = 0
-        editor_key = f"{key}_{st.session_state[f'{key}_number']}"
-
-        with st.form(key=f"{key}_form", border=False):
-            st.info(
-                (
-                    "You can edit data directly in the table. When done, click the "
-                    "**Apply changes** button below to rerun calculations."
-                )
-            )
-
-            st.form_submit_button(
-                "Apply changes",
-                type="primary",
-                on_click=register_user_changes,
-                kwargs={
-                    "missing_index_name": missing_index_name,
-                    "missing_index_value": missing_index_value,
-                    "index": index,
-                    "columns": columns,
-                    "values": "value",
-                    "df_tab": df,
-                    "df_orig": df_orig,
-                    "key": key,
-                    "editor_key": editor_key,
-                },
-            )
-
-            df = st.data_editor(
+        if data_type == "full load hours":
+            st.info("Full load hours data cannot be modified.")
+            st.dataframe(
                 df,
                 use_container_width=True,
-                key=editor_key,
-                num_rows="fixed",
-                disabled=[index],
                 column_config=column_config,
             )
+        else:
+            df = _form_data_editor(
+                key,
+                df,
+                df_orig,
+                index,
+                columns,
+                missing_index_name,
+                missing_index_value,
+                column_config,
+            )
 
     else:
         st.dataframe(