[UX] British spelling: rename optimization → optimisation throughout code (conflict resolve)

app.py

@@ -6,7 +6,7 @@ import pathlib
 import streamlit as st
 from streamlit_option_menu import option_menu
 from tabs import (tab0_welcome, tab1_inputs, tab2_constraints,
-                  tab3_coefficients, tab4_optimization, tab5_sensitivity,
+                  tab3_coefficients, tab4_optimisation, tab5_sensitivity,
                   tab6_scenarios)
 from utils.data_utils import load_slider_data, strip_unit_suffix
 from utils.state_utils import init_custom_resources
@@ -207,7 +207,7 @@ elif selected == "Method constraints":
 elif selected == "Resource coefficients":
     tab3_coefficients.render_tab(cost_sliders)
 elif selected == "Portfolio generation":
-    tab4_optimization.render_tab()
+    tab4_optimisation.render_tab()
 elif selected == "Sensitivity analysis":
     tab5_sensitivity.render_tab()
 elif selected == "Scenario comparison":

assets/styles.css

@@ -404,8 +404,8 @@ h1.custom-title {
     font-style: italic;
 }
 
-/* Run Optimization — CTA principal */
-.st-key-btn-run-optimization button {
+/* Run optimisation — CTA principal */
+.st-key-btn-run-optimisation button {
     border: none !important;
     border-radius: 0px;
     background: var(--green-dark) !important;
@@ -416,17 +416,17 @@ h1.custom-title {
     transition: background 0.25s ease, transform 0.15s ease;
     box-shadow: 4px 4px 0px var(--green);
 }
-.st-key-btn-run-optimization button:hover {
+.st-key-btn-run-optimisation button:hover {
     background: #01740f !important;
     color: var(--off-white) !important;
     transform: translate(-2px, -2px);
     box-shadow: 6px 6px 0px var(--green);
 }
-.st-key-btn-run-optimization button:active {
+.st-key-btn-run-optimisation button:active {
     transform: translate(0px, 0px);
     box-shadow: 2px 2px 0px var(--green);
 }
-.st-key-btn-run-optimization button p {
+.st-key-btn-run-optimisation button p {
     font-weight: 700 !important;
     font-size: clamp(15px, 1vw, 20px) !important;
     letter-spacing: 0.12em !important;

data/update.py

@@ -19,7 +19,7 @@ scripts = [
 ]
 
 print("=" * 60)
-print("CRRA Optimization Tool — data update")
+print("CRRA Optimisation Tool — data update")
 print("=" * 60)
 
 for label, script in scripts:

optimization/optimization.py → optimisation/optimisation.py

@@ -26,7 +26,7 @@ def build_custom_batch_structures(method_costs, resource_caps, custom_resources)
 
     Mutates method_costs (adds fallback median coefficients) and resource_caps
     (adds batch caps that are not yet present). Both dicts are already copies
-    when this function is called from run_optimization.
+    when this function is called from run_optimisation.
 
     Args:
         method_costs (dict): {method: {resource: coefficient}} — mutated in place.
@@ -531,7 +531,7 @@ def resolve_pooling_tiebreak(
     """Re-solve the LP with each method's output pinned, preferring the more
     efficient resource within each standard/custom pooling pair or family pool.
 
-    The main LP (run_optimization) maximises total CO2 removed only — nothing
+    The main LP (run_optimisation) maximises total CO2 removed only — nothing
     in its objective distinguishes a standard resource from a custom batch
     that substitutes for it (or from a same-family alternative resource), so
     when several could satisfy the same demand the solver picks an arbitrary
@@ -650,7 +650,7 @@ def compute_standalone_potential(method, resource_caps, method_costs, custom_res
             usage pairs once every other method is excluded).
         enabled_methods (dict | None): {resource: {method: bool}}.
         resource_to_group (dict | None): {resource: family group name} — see
-            build_family_pools. Must match what the outer run_optimization
+            build_family_pools. Must match what the outer run_optimisation
             call uses, so the method's standalone potential already reflects
             OR-availability across its own same-family resources.
 
@@ -659,7 +659,7 @@ def compute_standalone_potential(method, resource_caps, method_costs, custom_res
             produce anything on its own).
     """
     _UNCAPPED = 1e15
-    success, result = run_optimization(
+    success, result = run_optimisation(
         resource_caps=resource_caps,
         method_constraints={method: {"active": True, "cap_type": "absolute", "cap_value": _UNCAPPED}},
         method_costs={method: dict(method_costs.get(method, {}))},
@@ -670,7 +670,7 @@ def compute_standalone_potential(method, resource_caps, method_costs, custom_res
     return result["total_removed"] if success else 0.0
 
 
-def run_optimization(
+def run_optimisation(
     resource_caps,
     method_constraints,
     method_costs,

tabs/tab1_inputs.py

@@ -312,7 +312,7 @@ def dialog_add_custom_resource(cost_sliders, edit_index: int | None = None, pres
                 if edit_index is not None:
                     # Clean up stale costs[method][old_name] entries left behind by
                     # this edit — otherwise tab4's missing-resource check wrongly
-                    # deactivates that method on the next optimization run. Two
+                    # deactivates that method on the next optimisation run. Two
                     # triggers: (a) a method that was previously assigned is no
                     # longer checked, or (b) the batch itself was renamed, which
                     # orphans the old name even for methods still checked (the new

tabs/tab2_constraints.py

@@ -58,7 +58,7 @@ def get_all_missing_required(m, cost_sliders_norm):
 
     Family pooling: when two or more of the method's resources share the same
     resource family (e.g. "Arable land" and "Other land" are both "Land" — see
-    build_family_pools in optimization.py), they are OR-substitutable rather
+    build_family_pools in optimisation.py), they are OR-substitutable rather
     than all-required. A resource in such a family is only reported as missing
     if every member of that family is unavailable; a family member currently
     enabled as a secondary resource (its slider toggled on in Tab 3) also
@@ -159,7 +159,7 @@ def _render_resource_status(m, cost_sliders_norm):
 
     Family pooling: when 2+ of the method's required resources share the same
     resource family (e.g. "Forest biomass" / "Other biomass" are both
-    "Biomass" — see build_family_pools in optimization.py), only one of them
+    "Biomass" — see build_family_pools in optimisation.py), only one of them
     is actually needed. A family member that isn't set is shown as ✅
     "optional" (not a blocking ❌) once a sibling already satisfies the
     family, since adding it is a bonus, not a requirement.

tabs/{tab4_optimization.py → tab4_optimisation.py}

@@ -9,7 +9,7 @@ import pandas as pd
 import streamlit as st
 import plotly.express as px
 from config.config import CRRA_COLORS, PLOTLY_COLOR_SEQUENCE, PLOTLY_HEATMAP_SCALE, resource_order, resource_unit_map, resource_groups, secondary_resources, CO2_UNIT, method_order, section_intros
-from optimization.optimization import run_optimization
+from optimisation.optimisation import run_optimisation
 from utils.ui_helpers import apply_chart_style, register_chart_data, show_bar
 from utils.data_utils import (is_valid_scenario, is_complete_scenario, load_inputs_from_excel,
                               neutralize_zero_coefficient_methods, strip_unit_suffix,
@@ -20,7 +20,7 @@ from utils.state_utils import clear_widget_keys
 from config.config import hidden_resource_names as _hidden
 
 def panel_run_from_tabs():
-    """Left sub-panel: run optimization from manually filled tabs."""
+    """Left sub-panel: run optimisation from manually filled tabs."""
     st.markdown("**Option 1 - From current tab values**", unsafe_allow_html=True)
     st.markdown('<p class="caption">Set resource availability and method constraints in the tabs above, then run.</p>', unsafe_allow_html=True)
     st.divider() 
@@ -88,7 +88,7 @@ def parse_zip_scenario(uploaded) -> dict | None:
 
     The detailed outputs (resource_usage, resource_used_total, resource_remaining) 
     are NOT trusted from allocations.csv alone — they are
-    recomputed by re-running the optimizer on the reloaded inputs. This guarantees
+    recomputed by re-running the optimiser on the reloaded inputs. This guarantees
     the reloaded scenario is always internally consistent (and lets results pages
     render without missing keys), instead of relying on whatever was exported.
     """
@@ -200,7 +200,7 @@ def parse_zip_scenario(uploaded) -> dict | None:
             
             # Recompute detailed outputs from the reloaded inputs so the scenario
             # is internally consistent (rather than trusting allocations.csv alone).
-            success, result = run_optimization(
+            success, result = run_optimisation(
                 resource_caps=resource_caps,
                 method_constraints=constraints,
                 method_costs=costs,
@@ -255,7 +255,7 @@ def panel_load_from_json_or_csv():
 
     if "scenario_loaded_file" in st.session_state:
         st.success(
-            f"Scenario **{st.session_state['scenario_loaded_file']}** loaded :\n\nAll tabs updated - Optimization results displayed.",
+            f"Scenario **{st.session_state['scenario_loaded_file']}** loaded :\n\nAll tabs updated - optimisation results displayed.",
             icon="✅"
         )
     uploaded_json = st.file_uploader(
@@ -275,7 +275,7 @@ def panel_load_from_json_or_csv():
             st.error("Invalid scenario format.")
             return
         if not is_complete_scenario(data):
-            success, result = run_optimization(
+            success, result = run_optimisation(
                 resource_caps=data["resource_caps"],
                 method_constraints=data["method_constraints"],
                 method_costs=data["method_costs"],
@@ -302,7 +302,7 @@ def panel_load_from_json_or_csv():
     
     filename_stem = uploaded_json.name.rsplit(".", 1)[0]
  
-    if st.button("↩️ Reload scenario and run optimization", width='stretch'):
+    if st.button("↩️ Reload scenario and run optimisation", width='stretch'):
         st.session_state.setdefault("scenario_name_suggestion", filename_stem)
         st.session_state.pop("latest_result", None)
         st.session_state.pop("excel_loaded_file", None)
@@ -346,7 +346,7 @@ def run_and_store_result():
 
     Reads resource_caps, constraints, costs, custom_resources, and enabled_methods
     from session state. Applies enabled_methods overrides to a temporary cost copy,
-    neutralises zero-coefficient methods, runs run_optimization, then writes the
+    neutralises zero-coefficient methods, runs run_optimisation, then writes the
     full result dict to st.session_state.latest_result.
 
     Shows a Streamlit warning/error if inputs are invalid or optimisation fails.
@@ -503,7 +503,7 @@ def run_and_store_result():
             if group_cap_is_zero and batch_group in applied_costs[method_name]:
                 applied_costs[method_name][batch_group] = 0.0
 
-    success, result = run_optimization(
+    success, result = run_optimisation(
         resource_caps=resource_caps_for_lp,
         method_constraints=safe_constraints,
         method_costs=applied_costs,
@@ -513,7 +513,7 @@ def run_and_store_result():
     )
 
     if not success:
-        st.error("❌ Optimization failed")
+        st.error("❌ optimisation failed")
         if "message" in result:
             st.error(result["message"])
         return
@@ -529,7 +529,7 @@ def run_and_store_result():
     total_removed = result["total_removed"]
 
     if total_removed <= 0:
-        st.warning(f"❌ Optimization removed 0 {CO2_UNIT}. Relax constraints or increase resources.", icon=":material/warning:")
+        st.warning(f"❌ optimisation removed 0 {CO2_UNIT}. Relax constraints or increase resources.", icon=":material/warning:")
         return
 
     total_cost = sum(
@@ -586,7 +586,7 @@ def show_metrics(latest):
     """Render top-level KPI metrics and an optional custom-resource summary expander.
 
     Args:
-        latest (dict): result dict from run_optimization with keys summary, allocations,
+        latest (dict): result dict from run_optimisation with keys summary, allocations,
                        custom_resources.
 
     Returns:
@@ -1131,7 +1131,7 @@ def export_inputs_only():
 
     # Coefficients — a disabled (method, resource) pair is always exported
     # as 0, regardless of whether the user ever opened it in tab3. This
-    # keeps the export consistent with what the optimizer actually uses.
+    # keeps the export consistent with what the optimiser actually uses.
     ws3 = wb.create_sheet("coefficients")
     ws3.append(["method", "resource", "value", "secondary"])
     for m, resources in st.session_state.costs.items():
@@ -1333,7 +1333,7 @@ def render_tab():
     st.markdown(
         f"""
         <div class="text_with_border">
-            <p>{section_intros.get("tab4_optimization", "")}</p>
+            <p>{section_intros.get("tab4_optimisation", "")}</p>
         </div>
         """,
         unsafe_allow_html=True
@@ -1358,7 +1358,7 @@ def render_tab():
 
     with tab_run:
         st.markdown("""
-            <p class="crra-sub-heading">Run optimization</p>""",
+            <p class="crra-sub-heading">Run optimisation</p>""",
             unsafe_allow_html=True,
         )
         col_inputs, col_scenario = st.columns(2, gap="large")
@@ -1368,7 +1368,7 @@ def render_tab():
                 <p class="crra-sub-sub-heading">From inputs</p>""",
                 unsafe_allow_html=True,
             )
-            run_clicked = st.button("Run Optimization", icon=":material/play_arrow:", key="btn-run-optimization", type="primary")
+            run_clicked = st.button("Run optimisation", icon=":material/play_arrow:", key="btn-run-optimisation", type="primary")
             run_msg_area = st.container()
             panel_run_from_tabs()
             panel_load_from_excel()
@@ -1384,7 +1384,7 @@ def render_tab():
             with run_msg_area:
                 run_and_store_result()
 
-    no_results = '<p class="caption">Run the optimization first to see results here.</p>'
+    no_results = '<p class="caption">Run the optimisation first to see results here.</p>'
 
     latest = st.session_state.get("latest_result")
     if not latest:
@@ -1418,7 +1418,7 @@ def render_tab():
 
     with tab_results:
         show_metrics(latest)
-        st.markdown('<p class="crra-sub-heading">Optimization Summary</p>', unsafe_allow_html=True)
+        st.markdown('<p class="crra-sub-heading">optimisation Summary</p>', unsafe_allow_html=True)
         st.dataframe(df_display, width='stretch')
         st.markdown('<p class="crra-sub-heading">Method allocation breakdown</p>', unsafe_allow_html=True)
         st.markdown(
@@ -1455,6 +1455,6 @@ def render_tab():
     with tab_reset:
         reset_scenario("reset")
 
-    if st.button("Sensitivity analysis →", key="btn-nav-next-optimization", type="primary", help="Explore how resource or method changes affect your portfolio."):
+    if st.button("Sensitivity analysis →", key="btn-nav-next-optimisation", type="primary", help="Explore how resource or method changes affect your portfolio."):
         st.session_state["_navigate_to"] = "Sensitivity analysis"
         st.rerun()

tabs/tab5_sensitivity.py

@@ -3,7 +3,7 @@ import pandas as pd
 import streamlit as st
 import plotly.express as px
 from config.config import CO2_UNIT, hidden_resource_names, method_order, resource_order, resource_unit_map, section_intros
-from utils.data_utils import (get_resource_to_unit, get_resource_to_group, run_expanded_optimization,
+from utils.data_utils import (get_resource_to_unit, get_resource_to_group, run_expanded_optimisation,
                               is_other_method, get_other_method_variants, make_variant_name,
                               default_constraint)
 from utils.ui_helpers import register_chart_data, show_bar
@@ -18,7 +18,7 @@ def compute_baseline():
             all_resources     – standard resources + custom batch names.
             resource_to_unit  – {resource: unit} including custom batches.
     """
-    baseline_success, baseline_result = run_expanded_optimization(
+    baseline_success, baseline_result = run_expanded_optimisation(
         resource_caps=st.session_state.resource_caps,
         method_constraints=st.session_state.constraints,
         costs=st.session_state.costs,
@@ -98,7 +98,7 @@ def panel_resource_sensitivity(baseline_removed, all_resources, resource_to_unit
             actual_amount = base_cap * pct / 100
             perturbed_caps[resource] = actual_amount
 
-            success, result = run_expanded_optimization(
+            success, result = run_expanded_optimisation(
                 resource_caps=perturbed_caps,
                 method_constraints=st.session_state.constraints,
                 costs=st.session_state.costs,
@@ -162,7 +162,7 @@ def panel_method_sensitivity(baseline_removed):
 
     # "Other"-tagged methods with custom batches attached are expanded into
     # independent variants (e.g. "Enhanced weathering - Other mineral: Ganite")
-    # by run_expanded_optimization — offer those variants as selectable
+    # by run_expanded_optimisation — offer those variants as selectable
     # entries too, alongside the standard method names, so their own cap can
     # be swept just like any other method. An "Other"-tagged method with NO
     # batch attached has no variant AND can never produce any result on its
@@ -226,7 +226,7 @@ def panel_method_sensitivity(baseline_removed):
                 perturbed_constraints[method]["cap_value"] = actual_cap
                 cap_label = f"{actual_cap:.2f} {CO2_UNIT}/yr"
 
-            success, result = run_expanded_optimization(
+            success, result = run_expanded_optimisation(
                 resource_caps=st.session_state.resource_caps,
                 method_constraints=perturbed_constraints,
                 costs=st.session_state.costs,
@@ -267,7 +267,7 @@ def panel_method_sensitivity(baseline_removed):
 def show_bottleneck_analysis():
     """Render the resource sensitivity table (CDR gain per +1 unit of each resource).
 
-    Reads the latest optimization result from session state. Shows nothing if no
+    Reads the latest optimisation result from session state. Shows nothing if no
     result is available yet.
 
     Returns:

tabs/tab6_scenarios.py

@@ -4,7 +4,7 @@ import plotly.express as px
 import streamlit as st
 from config.config import CO2_UNIT, hidden_resource_names
 from utils.data_utils import is_valid_scenario
-from tabs.tab4_optimization import parse_zip_scenario
+from tabs.tab4_optimisation import parse_zip_scenario
 from utils.ui_helpers import apply_chart_style, register_chart_data, show_bar
 
 

utils/data_utils.py

@@ -9,7 +9,7 @@ from config.config import (
     resource_groups, method_groups, secondary_resources, CO2_UNIT,
     hidden_resource_names,
 )
-from optimization.optimization import run_optimization
+from optimisation.optimisation import run_optimisation
 
 def get_resource_to_group() -> dict[str, str]:
     """Map each resource name to its resource group.
@@ -245,10 +245,10 @@ def make_variant_name(method_name: str, batch_name: str) -> str:
     return f"{method_name}: {batch_name}"
 
 
-def run_expanded_optimization(resource_caps, method_constraints, costs, custom_resources, enabled_methods):
+def run_expanded_optimisation(resource_caps, method_constraints, costs, custom_resources, enabled_methods):
     """Apply the full Tab 4 preprocessing pipeline, then run the LP.
 
-    This is the same pipeline as tab4_optimization.run_and_store_result: apply
+    This is the same pipeline as tab4_optimisation.run_and_store_result: apply
     enabled_methods overrides, inject custom-batch coefficients, neutralise
     all-zero methods, deactivate methods missing a required resource, and —
     crucially — expand any "Other"-tagged method into one independent method
@@ -258,7 +258,7 @@ def run_expanded_optimization(resource_caps, method_constraints, costs, custom_r
 
     Any caller that needs LP results consistent with what Tab 4 actually shows
     (e.g. Tab 5's sensitivity sweeps) should use this instead of calling
-    run_optimization() directly with raw session-state costs — otherwise a
+    run_optimisation() directly with raw session-state costs — otherwise a
     custom resource attached to an "Other" method would be silently computed
     through the wrong mechanism and never show up as its own entry.
 
@@ -273,7 +273,7 @@ def run_expanded_optimization(resource_caps, method_constraints, costs, custom_r
         enabled_methods (dict): {resource: {method: bool}}.
 
     Returns:
-        tuple[bool, dict]: same shape as optimization.run_optimization()'s
+        tuple[bool, dict]: same shape as optimisation.run_optimisation()'s
             return value — (True, result_dict) or (False, {"message": str}).
     """
     applied_costs = {m: dict(v) for m, v in costs.items()}
@@ -359,7 +359,7 @@ def run_expanded_optimization(resource_caps, method_constraints, costs, custom_r
             if group_cap_is_zero and batch_group in applied_costs[method_name]:
                 applied_costs[method_name][batch_group] = 0.0
 
-    return run_optimization(
+    return run_optimisation(
         resource_caps=resource_caps_for_lp,
         method_constraints=safe_constraints,
         method_costs=applied_costs,