feat: add windows installer (#333)

* feat: add windows installer

* fix: use python unbuffered on windows

* fix: install git into windows environment

* fix: windows installer needs to locate binaries first

* feat: add shell script for building windows installer

* fix: Speed up uninstalling by batch removing directories first

* fix: gitignore installer build artifacts

* fix: small fixes to windows installer

* fix(installer): clean up wording slightly

* feat: bundle repository into windows installer

* fix: make sure no spaces are in repository directory

* feat: add gh workflow to build and attach the windows installer to releases

* Add documentation and release notes

* Update pixi.lock

* Updates README.md

* fix: remove pixi from installer name

* fix: add INSTDIR to PATH

* fix: install snakemake from open-tyndp channel

* feat: make pixi environment install optional

* fix: add version constraints

* fix: update snakemake-minimal to 9.14.5+opentyndp.1

* fix: compatibility of build_gas_* rules with pyogrio >=0.12.0

pyogrio >=0.12.0 returns JSON fields directly as dicts/lists, so that loading them again
as json fails.

refer to https://github.com/geopandas/pyogrio/releases/tag/v0.12.0 .

* fix: apply suggestions from thomas

* Apply suggestion from Thomas on windows-installer Readme

* fix(docs): fix installation heading levels

* fix typo

* Update pixi.toml

* doc: add installer in the documentation

* chore: solve merge conflicts

---------

Co-authored-by: Thomas Gilon <thomas.gilon@openenergytransition.org>

Author: coroa

.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

@@ -51,6 +51,7 @@ The back-casting of the 2024 TYNDP cycle involves developing new features based
 - Added the TOOT reference and project network preparation for CBA (see PRs [#199](https://github.com/open-energy-transition/open-tyndp/pull/199), [#211](https://github.com/open-energy-transition/open-tyndp/pull/211)).
 - Added weekly rolling horizon optimization for CBA networks (see PR [#217](https://github.com/open-energy-transition/open-tyndp/pull/217)).
 - Introduced calculation of B1 indicator in the CBA based on changes in total system costs (see PR [#186](https://github.com/open-energy-transition/open-tyndp/pull/186)).
+- Added automated Windows installer for easy setup on Windows systems (see PR [#333](https://github.com/open-energy-transition/open-tyndp/pull/333)).
 
 
 
@@ -122,6 +123,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/index.rst

@@ -98,6 +98,7 @@ The back-casting of the 2024 TYNDP cycle involves developing new features based
 - Added the TOOT reference and project network preparation for CBA (see PRs `#199 <https://github.com/open-energy-transition/open-tyndp/pull/199>`__, `#211 <https://github.com/open-energy-transition/open-tyndp/pull/211>`__).
 - Added weekly rolling horizon optimization for CBA networks (see PR `#217 <https://github.com/open-energy-transition/open-tyndp/pull/217>`__).
 - Introduced calculation of B1 indicator in the CBA based on changes in total system costs (see PR `#186 <https://github.com/open-energy-transition/open-tyndp/pull/186>`__).
+- Added automated Windows installer for easy setup on Windows systems (see PR `#333 <https://github.com/open-energy-transition/open-tyndp/pull/333>`__).
 
 
 

doc/installation.rst

@@ -13,10 +13,38 @@ The subsequently described installation steps are demonstrated as shell commands
 directory in which the commands following the ``%`` should be entered.
 
 
+.. _windows_installer:
+
+Option A: 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.
+
+
+.. _manual_installation
+
+Option B: Manual installation (All Platforms)
+=============================================
+
 .. _clone_repo:
 
 Clone the Repository
-====================
+--------------------
 
 First of all, clone the `Open-TYNDP repository <https://github.com/open-energy-transition/open-tyndp>`__ using the version control system ``git`` in the command line.
 
@@ -28,10 +56,10 @@ First of all, clone the `Open-TYNDP repository <https://github.com/open-energy-t
 .. _deps:
 
 Install Python Dependencies
-===============================
+---------------------------
 
 Preferred method: ``pixi``
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 PyPSA-Eur, and consequently Open-TYNDP, relies on a set of other Python packages to function.
 We manage these using `pixi <https://pixi.sh/latest/>`_.
@@ -49,7 +77,7 @@ Once pixi is installed, you can activate the project environment for your operat
     We don't currently support linux operating systems using ARM processors since certain packages, such as ``PySCIPOpt``, require being built from source.
 
 Legacy method: ``conda``
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you cannot access ``pixi`` on your machine, you can also install using `conda <https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html>`_ (or ``mamba``/``micromamba``).
 To do so, we highly recommend you install from one of our platform-specific environment files:
@@ -87,7 +115,7 @@ If you are having difficulties with the above files, you can also install direct
 
 
 Install a Solver
-================
+----------------
 
 PyPSA passes the PyPSA-Eur network model to an external solver for performing the optimisation.
 PyPSA is known to work with the free software

doc/release_notes.rst

@@ -11,6 +11,8 @@ Release Notes
 Upcoming Open-TYNDP Release
 ================
 
+* Added automated Windows installer for easy setup on Windows systems (https://github.com/open-energy-transition/open-tyndp/pull/333). 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.
+
 * Docs: Add innovation roadmap comparison, mapping existing or new developments in PyPSA-Eur and Open TYNDP to desired features for TYNDP 2026 (https://github.com/open-energy-transition/open-tyndp/pull/341)
 
 * Fix Windows compatibility issues and make other minor improvements (https://github.com/open-energy-transition/open-tyndp/pull/357).