feat: add windows installer

.github/workflows/release-installer.yaml

@@ -0,0 +1,53 @@
+# SPDX-FileCopyrightText: Contributors to Open-TYNDP <https://github.com/open-energy-transition/open-tyndp>
+#
+# SPDX-License-Identifier: MIT
+
+name: Build and Attach Installer to Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      release_tag:
+        description: 'Release tag to attach installer to'
+        required: true
+        type: string
+
+jobs:
+  build-and-attach-installer:
+    name: Build Windows Installer and Attach to Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        ref: ${{ github.event.release.tag_name || inputs.release_tag }}
+
+    - name: Setup Pixi
+      uses: prefix-dev/setup-pixi@v0.9.3
+      with:
+        pixi-version: v0.59.0
+        cache: true
+        cache-write: false
+
+    - name: Get version from release tag
+      id: get_version
+      run: |
+        TAG="${{ github.event.release.tag_name || inputs.release_tag }}"
+        VERSION=${TAG#v}
+        echo "version=$VERSION" >> $GITHUB_OUTPUT
+        echo "tag=$TAG" >> $GITHUB_OUTPUT
+
+    - name: Build Windows installer
+      env:
+        VERSION: ${{ steps.get_version.outputs.version }}
+      run: |
+        utils/windows-installer/build_installer.sh
+
+    - name: Upload installer to release
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        gh release upload ${{ steps.get_version.outputs.tag }} utils/windows-installer/open-tyndp-*.exe --clobber

.gitignore

@@ -120,3 +120,6 @@ CLAUDE.local.md
 
 linopy-problem-*
 linopy-solve-*
+
+# Installer build artifacts
+*.exe

README.md

@@ -122,6 +122,12 @@ While multiple TYNDP features are already introduced to the Open-TYNDP model, th
 
 ## 1. Installation
 
+### Option A: Windows Installer (Recommended for Windows)
+
+For Windows users, download the latest installer (e.g., `open-tyndp-0.4.0-pixi-Windows-x86_64.exe`) from the [releases page](https://github.com/open-energy-transition/open-tyndp/releases) and run it. The installer automatically sets up everything you need, including pixi, the repository, and the conda environment. See `utils/windows-installer/README.md` for details.
+
+### Option B: Manual Installation (All Platforms)
+
 Clone the repository:
 
 ```sh

REUSE.toml

@@ -50,3 +50,10 @@ path = [
 ]
 SPDX-FileCopyrightText = "Open Energy Transition gGmbH"
 SPDX-License-Identifier = "MIT"
+
+[[annotations]]
+path = [
+    "utils/windows-installer/oet_logo.*",
+]
+SPDX-FileCopyrightText = "Open Energy Transition gGmbH"
+SPDX-License-Identifier = "CC-BY-4.0"

doc/installation.rst

@@ -13,6 +13,29 @@ The subsequently described installation steps are demonstrated as shell commands
 directory in which the commands following the ``%`` should be entered.
 
 
+.. _windows_installer:
+
+Windows Installer (Recommended for Windows)
+============================================
+
+For Windows users, the easiest way to install Open-TYNDP is using the automated installer. Download the latest installer executable (e.g., ``open-tyndp-0.4.0-pixi-Windows-x86_64.exe``) from the `GitHub releases page <https://github.com/open-energy-transition/open-tyndp/releases>`__ and run it.
+
+The installer will:
+
+1. Install pixi package manager to ``%LOCALAPPDATA%\open-tyndp``
+2. Extract the repository files to your chosen installation directory
+3. Set up the conda environment automatically via ``pixi install``
+4. Create Start Menu shortcuts for easy access:
+
+   - **Open-TYNDP PowerShell** - Launch PowerShell with environment activated
+   - **Open-TYNDP Command Prompt** - Launch Command Prompt with environment activated
+
+For more details about the installer, see ``utils/windows-installer/README.md`` in the repository.
+
+.. note::
+    If you prefer manual installation or need more control over the setup process, follow the instructions below for cloning the repository and installing dependencies manually.
+
+
 .. _clone_repo:
 
 Clone the Repository

doc/release_notes.rst

@@ -11,6 +11,8 @@ Release Notes
 Upcoming Open-TYNDP Release
 ================
 
+* Added automated Windows installer for easy setup on Windows systems. The installer bundles pixi, the repository, and sets up the conda environment automatically. Installer executables are automatically built and attached to GitHub releases. See ``utils/windows-installer/`` for details.
+
 
 Upcoming PyPSA-Eur Release
 ================

pixi.toml

@@ -5,11 +5,18 @@
 
 [workspace]
 authors = ["Contributors to Open-TYNDP"]
-channels = ["conda-forge", "bioconda", "gurobi"]
+channels = ["conda-forge", "bioconda", "gurobi", "https://repo.prefix.dev/open-tyndp"]
 name = "pypsa-eur"
 platforms = ["win-64", "linux-64", "osx-64", "osx-arm64"]
 version = "0.1.0"
 
+[target.win-64.activation.env]
+
+# Local snakemake jobs often fail with status code 120, due to stdout/stderr interleaving
+# on windows, running python unbuffered works around the issue. Ideally we would stop using
+# stdout/stderr and use a proper logging infrastructure
+PYTHONUNBUFFERED = "1"
+
 [tasks]
 
 reset = """bash -c '
@@ -63,13 +70,14 @@ matplotlib = ">=3.10.7"
 memory_profiler = ">=0.61.0"
 netcdf4 = ">=1.7.2"
 networkx = ">=3.5"
-numpy = ">=1.26.4"
+numpy = ">=1.26.4,<2"
 openpyxl = ">=3.1.5"
 pandas = ">=2.1"
 plotly = ">=6.4.0"
 powerplantmatching = ">=0.5.15"
 pre-commit = ">=4.3.0"
 proj = ">=9.6.2"
+pydeck = ">=0.8"
 pylint = ">=4.0.2"
 pypsa = ">=0.35.2"
 pyscipopt = ">=5.6.0"
@@ -179,8 +187,12 @@ tyndp = """bash -c '
  all-tests = {depends-on = ["tyndp-sb-test", "tyndp-cba-test", "clean-tyndp", "integration-tests", "clean-tests", "unit-tests"]}
 
 [feature.open-tyndp.dependencies]
+snakemake-minimal = { version = ">=9", channel = "https://repo.prefix.dev/open-tyndp" }
 pixi-pycharm = ">=0.0.9"
 
+[feature.open-tyndp.target.win-64.dependencies]
+git = ">=2.52.0"
+
 [environments]
 doc = { features = ["doc"], no-default-feature = true }
 test = ["test"]

scripts/build_gas_input_locations.py

@@ -6,21 +6,21 @@
 production sites with data from SciGRID_gas and Global Energy Monitor.
 """
 
-import json
 import logging
 
 import geopandas as gpd
 import pandas as pd
 
 from scripts._helpers import configure_logging, set_scenario_config
+from scripts.build_gas_network import unnest_struct
 from scripts.cluster_gas_network import load_bus_regions
 
 logger = logging.getLogger(__name__)
 
 
 def read_scigrid_gas(fn):
     df = gpd.read_file(fn)
-    expanded_param = df.param.apply(json.loads).apply(pd.Series)
+    expanded_param = unnest_struct(df.param)
     df = pd.concat([df, expanded_param], axis=1)
     df.drop(["param", "uncertainty", "method"], axis=1, inplace=True)
     df = df.loc[:, ~df.columns.duplicated()]  # duplicated country_code column

scripts/build_gas_network.py

@@ -53,11 +53,16 @@ def diameter_to_capacity(pipe_diameter_mm):
         return a3 + m3 * pipe_diameter_mm
 
 
+def unnest_struct(s):
+    if isinstance(s.iloc[0], str):
+        s = s.apply(json.loads)
+    return s.apply(pd.Series)
+
+
 def load_dataset(fn):
     df = gpd.read_file(fn)
-    param = df.param.apply(json.loads).apply(pd.Series)
-    cols = ["diameter_mm", "max_cap_M_m3_per_d"]
-    method = df.method.apply(json.loads).apply(pd.Series)[cols]
+    param = unnest_struct(df.param)
+    method = unnest_struct(df.method)[["diameter_mm", "max_cap_M_m3_per_d"]]
     method.columns = method.columns + "_method"
     df = pd.concat([df, param, method], axis=1)
     to_drop = ["param", "uncertainty", "method", "tags"]