simdec 1.5.0__tar.gz → 1.5.2__tar.gz

{simdec-1.5.0 → simdec-1.5.2}/.gitignore

@@ -35,3 +35,11 @@ sdist/*
 docs/html
 docs/jupyter_execute
 app.html
+
+# Virtual environment
+venv/
+.venv/
+.wasm-build-venv/
+
+# Local Netlify folder
+.netlify

{simdec-1.5.0 → simdec-1.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: simdec
-Version: 1.5.0
+Version: 1.5.2
 Summary: Sensitivity analysis using simulation decomposition
 Project-URL: homepage, https://www.simdec.fi/
 Project-URL: documentation, https://simdec.readthedocs.io
@@ -30,7 +30,7 @@ Requires-Dist: panel>=1.4.5; extra == 'dashboard'
 Provides-Extra: dev
 Requires-Dist: accessible-pygments; extra == 'dev'
 Requires-Dist: cryptography; extra == 'dev'
-Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: ipython>=9.1; extra == 'dev'
 Requires-Dist: myst-nb; extra == 'dev'
 Requires-Dist: numpydoc; extra == 'dev'
 Requires-Dist: panel>=1.4.5; extra == 'dev'
@@ -40,6 +40,8 @@ Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: sphinx; extra == 'dev'
 Requires-Dist: watchfiles; extra == 'dev'
+Provides-Extra: display
+Requires-Dist: ipython>=9.1; extra == 'display'
 Provides-Extra: doc
 Requires-Dist: accessible-pygments; extra == 'doc'
 Requires-Dist: myst-nb; extra == 'doc'
@@ -95,5 +97,6 @@ Foundation, and Finnish Foundation for Economic Education.
 If you use SimDec in your research we would appreciate a citation to the
 following publications:
 
+- Kozlova, M., Ahola, A., Roy, P., & Yeomans, J. S. (2025). Simple Binning Algorithm and SimDec Visualization for Comprehensive Sensitivity Analysis of Complex Computational Models. _Journal of Environmental Informatics Letters_, 13(1), 38-56. [https://arxiv.org/pdf/2310.13446](https://arxiv.org/pdf/2310.13446)
 - Kozlova, M., Moss, R. J., Yeomans, J. S., & Caers, J. (2024). Uncovering Heterogeneous Effects in Computational Models for Sustainable Decision-making. _Environmental Modelling & Software_, 171, 105898. [https://doi.org/10.1016/j.envsoft.2023.105898](https://doi.org/10.1016/j.envsoft.2023.105898)
 - Kozlova, M., Moss, R. J., Roy, P., Alam, A., & Yeomans, J. S. (2024). SimDec algorithm and guidelines for its usage and interpretation. In M. Kozlova & J. S. Yeomans (Eds.), _Sensitivity Analysis for Business, Technology, and Policymaking. Made Easy with Simulation Decomposition_. Routledge. [Available here](https://github.com/Simulation-Decomposition/SimDec-book/blob/74ce72c1d3dda650eba1c59e3b215a4bb35c6be0/chapters/02_SimDec_algorithm_and_instructions/Ch2.pdf).

{simdec-1.5.0 → simdec-1.5.2}/README.md

@@ -42,5 +42,6 @@ Foundation, and Finnish Foundation for Economic Education.
 If you use SimDec in your research we would appreciate a citation to the
 following publications:
 
+- Kozlova, M., Ahola, A., Roy, P., & Yeomans, J. S. (2025). Simple Binning Algorithm and SimDec Visualization for Comprehensive Sensitivity Analysis of Complex Computational Models. _Journal of Environmental Informatics Letters_, 13(1), 38-56. [https://arxiv.org/pdf/2310.13446](https://arxiv.org/pdf/2310.13446)
 - Kozlova, M., Moss, R. J., Yeomans, J. S., & Caers, J. (2024). Uncovering Heterogeneous Effects in Computational Models for Sustainable Decision-making. _Environmental Modelling & Software_, 171, 105898. [https://doi.org/10.1016/j.envsoft.2023.105898](https://doi.org/10.1016/j.envsoft.2023.105898)
 - Kozlova, M., Moss, R. J., Roy, P., Alam, A., & Yeomans, J. S. (2024). SimDec algorithm and guidelines for its usage and interpretation. In M. Kozlova & J. S. Yeomans (Eds.), _Sensitivity Analysis for Business, Technology, and Policymaking. Made Easy with Simulation Decomposition_. Routledge. [Available here](https://github.com/Simulation-Decomposition/SimDec-book/blob/74ce72c1d3dda650eba1c59e3b215a4bb35c6be0/chapters/02_SimDec_algorithm_and_instructions/Ch2.pdf).

simdec-1.5.2/netlify.toml

@@ -0,0 +1,24 @@
+[build]
+  command = "npm run build"
+  publish = "dist/pyodide"
+
+[dev]
+  ignore = ["dist", ".wasm-build-venv", "panel/data"]
+  port = 8888
+
+[build.environment]
+  PYTHON_VERSION = "3.11"
+  NODE_VERSION = "20"
+  CACHE_VERSION = "2"
+
+[[headers]]
+  for = "/*"
+  [headers.values]
+    Cross-Origin-Embedder-Policy = "require-corp"
+    Cross-Origin-Opener-Policy = "same-origin"
+
+[[headers]]
+  for = "/*.whl"
+  [headers.values]
+    Content-Type = "application/zip"
+    Access-Control-Allow-Origin = "*"

simdec-1.5.2/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "simdec-wasm-site",
+  "private": true,
+  "version": "1.0.0",
+  "description": "Static Panel WASM build wrapper",
+  "scripts": {
+    "build": "bash ./scripts/build_wasm.sh",
+    "serve": "mkdir -p dist/pyodide && python3 -m http.server 8000 --directory dist/pyodide"
+  }
+}

{simdec-1.5.0 → simdec-1.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "simdec"
-version = "1.5.0"
+version = "1.5.2"
 description = "Sensitivity analysis using simulation decomposition"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -41,6 +41,10 @@ dashboard = [
     "cryptography",
 ]
 
+display = [
+    "ipython>=9.1"
+]
+
 test = [
     "pytest",
     "pytest-cov",
@@ -55,10 +59,9 @@ doc = [
 ]
 
 dev = [
-    "simdec[doc,test,dashboard]",
+    "simdec[doc,test,dashboard, display]",
     "watchfiles",
     "pre-commit",
-    "hatch",
 ]
 
 [project.urls]

simdec-1.5.2/scripts/build_wasm.sh

@@ -0,0 +1,140 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# Logging
+set -x
+
+# Setup paths and environment
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+OUT_DIR="${ROOT_DIR}/dist/pyodide"
+
+# Wipe old build before starting
+if [ -d "${OUT_DIR}" ]; then
+    echo "Cleaning old build..."
+    rm -rf "${OUT_DIR}"
+fi
+
+cd "${ROOT_DIR}"
+
+# Determine which Python interpreter to use
+HOST_PYTHON="${PYTHON_BIN:-}"
+if [[ -z "${HOST_PYTHON}" ]]; then
+    if command -v python3 >/dev/null 2>&1; then
+        HOST_PYTHON="python3"
+    elif command -v python >/dev/null 2>&1; then
+        HOST_PYTHON="python"
+    else
+        echo "Error: No python interpreter found. Install python3 and retry."
+        exit 1
+    fi
+fi
+
+# Create build virtual environment
+VENV_DIR="${ROOT_DIR}/.wasm-build-venv"
+if [[ ! -d "${VENV_DIR}" ]]; then
+    echo "Creating build virtual environment at ${VENV_DIR}..."
+    "${HOST_PYTHON}" -m venv "${VENV_DIR}"
+fi
+
+PYTHON_BIN="${VENV_DIR}/bin/python"
+
+# Install build dependencies and build the wheel
+echo "Installing build tools and generating local wheel..."
+"${PYTHON_BIN}" -m pip install --upgrade pip build \
+    "panel==1.8.10" \
+    "bokeh==3.8.0" \
+    "matplotlib==3.10.8" \
+    "seaborn==0.13.2" \
+    "scipy==1.17.1" \
+    "SALib==1.5.2"
+# Clean old builds to avoid picking up the wrong wheel
+rm -rf dist/*.whl
+"${PYTHON_BIN}" -m build --wheel .
+
+# Identify the generated wheel file
+SIMDEC_WHEEL_PATH=$(ls dist/*.whl | head -n 1 || echo "")
+
+if [[ -z "${SIMDEC_WHEEL_PATH}" ]]; then
+    echo "Error: No wheel file found in dist/. Build failed."
+    exit 1
+fi
+
+WHEEL_FILENAME=$(basename "${SIMDEC_WHEEL_PATH}")
+
+# Prepare output directory - USE ABSOLUTE PATH
+OUT_DIR="${ROOT_DIR}/dist/pyodide"
+mkdir -p "${OUT_DIR}/_static"
+mkdir -p "${OUT_DIR}/data"
+
+# Copy the wheel into the output directory so it's accessible via HTTP
+cp "${SIMDEC_WHEEL_PATH}" "${OUT_DIR}/"
+
+# Copy the assets to where the Python scripts expect them
+mkdir -p panel/_static
+if [ -d "docs/_static" ]; then
+  # Use || true to prevent failure if it's empty
+  cp -r docs/_static/* panel/_static/ || true
+fi
+
+echo "Converting Panel apps to Pyodide worker output..."
+export PYTHONPATH="${ROOT_DIR}/src:${PYTHONPATH:-}"
+
+# Change directory into 'panel' so relative paths resolve correctly
+cd "${ROOT_DIR}/panel"
+
+# Bring the wheel into the current folder so we can pass just the filename
+cp "${ROOT_DIR}/${SIMDEC_WHEEL_PATH}" .
+
+# Safe file checking that won't trigger set -e
+echo "Checking necessary files locally before conversion..."
+if [[ ! -f "simdec_app.py" ]]; then echo "Warning: simdec_app.py not found in panel directory!"; fi
+if [[ ! -f "sampling.py" ]]; then echo "Warning: sampling.py not found in panel directory!"; fi
+
+# Ensure data/stress.csv exists relative to the current 'panel' dir
+if [[ ! -f "data/stress.csv" ]]; then
+    echo "Warning: panel/data/stress.csv missing."
+    if [[ -f "../data/stress.csv" ]]; then
+        echo "Found stress.csv in root. Copying to panel/data..."
+        mkdir -p data
+        cp "../data/stress.csv" data/
+    else
+        echo "Error: stress.csv not found anywhere! Conversion may fail."
+    fi
+fi
+
+# Copy stress.csv to output directory
+cp "data/stress.csv" "${OUT_DIR}/data/"
+
+# Run conversion
+"${PYTHON_BIN}" -m panel convert \
+    simdec_app.py \
+    sampling.py \
+    --to pyodide-worker \
+    --out "${OUT_DIR}" \
+    --requirements "${WHEEL_FILENAME}" numpy pandas matplotlib seaborn scipy SALib \
+    --resources data/stress.csv
+
+cp "./${WHEEL_FILENAME}" "${OUT_DIR}/"
+
+# Clean up the copied wheel
+rm "${WHEEL_FILENAME}"
+
+# Step back out to the root directory for the rest of the script
+cd "${ROOT_DIR}"
+
+# Copy custom index page and static assets
+echo "Copying custom index page and static assets..."
+
+# Copy images/thumbnails from docs/_static if they exist
+if [ -d "docs/_static" ]; then
+    cp -r docs/_static/* "${OUT_DIR}/_static/" || true
+fi
+
+# Overwrite default index.html with your custom homepage
+if [ -f "panel/index.html" ]; then
+    cp panel/index.html "${OUT_DIR}/index.html"
+else
+    echo "Warning: panel/index.html not found. Using default Panel index."
+fi
+
+echo "---"
+echo "WASM site successfully generated at ${OUT_DIR}"

{simdec-1.5.0 → simdec-1.5.2}/src/simdec/__init__.py

@@ -1,5 +1,6 @@
 """SimDec main namespace."""
 from simdec.decomposition import *
+from simdec.heterogeneity_indices import *
 from simdec.sensitivity_indices import *
 from simdec.visualization import *
 
@@ -8,6 +9,8 @@ __all__ = [
     "states_expansion",
     "decomposition",
     "visualization",
+    "two_output_visualization",
     "tableau",
     "palette",
+    "heterogeneity_indices",
 ]

{simdec-1.5.0 → simdec-1.5.2}/src/simdec/decomposition.py

@@ -68,7 +68,7 @@ def decomposition(
     output: pd.DataFrame,
     *,
     sensitivity_indices: np.ndarray,
-    dec_limit: float = 1,
+    dec_limit: float | None = None,
     auto_ordering: bool = True,
     states: list[int] | None = None,
     statistic: Literal["mean", "median"] | None = "mean",
@@ -79,7 +79,7 @@ def decomposition(
     ----------
     inputs : DataFrame of shape (n_runs, n_factors)
         Input variables.
-    output : DataFrame of shape (n_runs, 1)
+    output : DataFrame of shape (n_runs, 1) or (n_runs,)
         Target variable.
     sensitivity_indices : ndarray of shape (n_factors, 1)
         Sensitivity indices, combined effect of each input.
@@ -116,7 +116,7 @@ def decomposition(
         inputs[cat_col] = codes
 
     inputs = inputs.to_numpy()
-    output = output.to_numpy()
+    output = output.to_numpy().flatten()
 
     # 1. variables for decomposition
     var_order = np.argsort(sensitivity_indices)[::-1]
@@ -125,26 +125,41 @@ def decomposition(
     sensitivity_indices = sensitivity_indices[var_order]
 
     if auto_ordering:
-        n_var_dec = np.where(np.cumsum(sensitivity_indices) < dec_limit)[0].size
+        # handle edge case where sensitivity indices don't sum exactly to 1.0
+        if dec_limit is None:
+            dec_limit = 0.8 * np.sum(sensitivity_indices)
+
+        cumulative_sum = np.cumsum(sensitivity_indices)
+        indices_over_limit = np.where(cumulative_sum >= dec_limit)[0]
+
+        if indices_over_limit.size > 0:
+            n_var_dec = indices_over_limit[0] + 1
+        else:
+            n_var_dec = sensitivity_indices.size
+
         n_var_dec = max(1, n_var_dec)  # keep at least one variable
-        n_var_dec = min(5, n_var_dec)  # use at most 5 variables
+        n_var_dec = min(4, n_var_dec)  # use at most 4 variables
     else:
         n_var_dec = inputs.shape[1]
 
-    # 2. states formation
+    # 2. variable selection and reordering
+    if auto_ordering:
+        var_names = var_names[var_order[:n_var_dec]].tolist()
+        inputs = inputs[:, var_order[:n_var_dec]]
+    else:
+        var_names = var_names[:n_var_dec].tolist()
+        inputs = inputs[:, :n_var_dec]
+
+    # 3. states formation (after reordering/selection)
     if states is None:
-        states = 3 if n_var_dec < 3 else 2
+        states = 3 if n_var_dec <= 2 else 2
         states = [states] * n_var_dec
 
         for i in range(n_var_dec):
             n_unique = np.unique(inputs[:, i]).size
             states[i] = n_unique if n_unique <= 5 else states[i]
 
-    if auto_ordering:
-        var_names = var_names[var_order[:n_var_dec]].tolist()
-        inputs = inputs[:, var_order[:n_var_dec]]
-
-    # 3. decomposition
+    # 4. decomposition
     bins = []
 
     statistic_methods = {
@@ -153,8 +168,8 @@ def decomposition(
     }
     try:
         statistic_method = statistic_methods[statistic]
-    except IndexError:
-        msg = f"'statistic' must be one of {statistic_methods.values()}"
+    except KeyError:
+        msg = f"'statistic' must be one of {statistic_methods.keys()}"
         raise ValueError(msg)
 
     def statistic_(inputs):