feat: add windows installer by coroa · Pull Request #333 · open-energy-transition/open-tyndp

coroa · 2025-12-17T15:01:05Z

This PR closes #335

Changes proposed in this Pull Request

Adds an automatically built Windows installer (e.g., open-tyndp-0.4.0-pixi-Windows-x86_64.exe) with GitHub Actions automation for releases.

How It Works

Installation: Copies pixi.exe to %LOCALAPPDATA%\open-tyndp
Repository Setup: Bundles shallow repository clone directly in installer
Environment Installation: Runs pixi install to download and set up conda environment
Shortcuts: Creates Start Menu shortcuts that activate environment via pixi shell

Implementation Details

Installer script: NSIS-based installer in utils/windows-installer/installer.nsi
Build automation: .github/workflows/release-installer.yaml builds on release tags
Repository bundling: Installer includes shallow repository clone (ie is for one specific version)
Dependencies: Git added to Windows pixi environment for post-install updates

Notes

Users can still update via git after installation since git is included in the environment. The bundled repository ensures the installer always provides a working, tested version.

Tests

Installer ran successfully on virtualbox VM running Windows 10 Pro and on GCP Windows Server 2022.

Screenshots

Installing

Shortcuts

Running

Uninstalling

Checklist

coroa · 2025-12-18T12:55:15Z

Ok, this one is ready for review. Not sure, how you want to go about testing this and where, @lisazeyen ?

lisazeyen · 2025-12-18T13:09:10Z

Looks very nice! Maybe as a first step @cdgaete can test it?

coroa · 2025-12-18T13:31:02Z

Looks very nice! Maybe as a first step @cdgaete can test it?

Carlos, you can find a prepared installer at: https://drive.google.com/open?id=1_8PXajcZQm08n6e_C7sPO1f5peHalaiS&usp=drive_copy

…leases

coroa · 2026-01-05T18:51:55Z

@tgilon @lisazeyen I split out the few small fixes like normalizing the line endings into #357 . This should make the review of this PR quite a bit easier.

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 .

tgilon

Thank you @coroa for this PR! This is a significant step forward to improve the cross-platform compatibility of our work. I haven't tested the installer myself, but the code looks good.

Some additional comments:

Could you specify somewhere the Windows version you used to test things? I think it's important for reproducibility purposes.
Could you also add this as a new feature in both in README and in index.rst?
There is a typo in the PR description. It's not pixi_installer.nsi but installer.nsi.

tgilon · 2026-01-06T16:12:55Z

This is difficult to review. Have you tested it?

No, this is still untested. it would need to be run on an existing release. i think i could run it on 0.4.1.

I'd propose to merge this and #357 now and try to create a 0.4.2a1 release, ie. an alpha release.

Good for me to release an alpha. Following the SemVer convention, I would suggest v0.4.2-alpha and mark it as a pre-release.

As always everyone has their own ideas about how stuff ideally looks like: Python packaging user guide, but python is flexible and will be fine with your suggestion too, ie check the section on normalization.

tgilon · 2026-01-06T16:17:01Z

+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.


What do you think about releasing a v0.4.2 to get the installer attached to the latest release?

that would be ideal i think.

coroa · 2026-01-07T13:04:03Z

Ok, i think i addressed everything except for:

Could you also add this as a new feature in both in README and in index.rst?

@tgilon What do you mean by that?

coroa · 2026-01-07T14:18:29Z

Zenodo making waves again: PyPSA/powerplantmatching#276 . We did not change anything in the PR commits. I'd merge w/o waiting for CI.

tgilon · 2026-01-07T16:11:37Z

Could you also add this as a new feature in both in README and in index.rst?

@tgilon What do you mean by that?

We usually document major features in the documentation itself. I think that this PR is one of them. I suggest adding it to the list of major features in both doc/index.rst and README.

coroa · 2026-01-07T16:38:48Z

Could you also add this as a new feature in both in README and in index.rst?

@tgilon What do you mean by that?

We usually document major features in the documentation itself. I think that this PR is one of them. I suggest adding it to the list of major features in both doc/index.rst and README.

I unfortunately broke my open-tyndp time budget for at least this week already. Maybe can get to it next week.

daniel-rdt · 2026-01-08T13:54:20Z

Could you also add this as a new feature in both in README and in index.rst?

@tgilon What do you mean by that?

We usually document major features in the documentation itself. I think that this PR is one of them. I suggest adding it to the list of major features in both doc/index.rst and README.

I unfortunately broke my open-tyndp time budget for at least this week already. Maybe can get to it next week.

Maybe @tgilon or I can address the last change in the README and index.rst, so we can merge sooner? Or am I missing any other open tasks on this PR? @coroa

tgilon · 2026-01-08T14:11:09Z

Maybe @tgilon or I can address the last change in the README and index.rst, so we can merge sooner? Or am I missing any other open tasks on this PR? @coroa

I just did it in 73b9de1. I'm currently running the tests locally.

Conflicts: pixi.lock

daniel-rdt · 2026-01-08T14:25:30Z

Maybe @tgilon or I can address the last change in the README and index.rst, so we can merge sooner? Or am I missing any other open tasks on this PR? @coroa

I just did it in 73b9de1. I'm currently running the tests locally.

Ah great! Thanks!

tgilon · 2026-01-08T16:36:06Z

As reported in PyPSA/powerplantmatching#276, powerplantmatching has retrieval issues. Local tests passed with d121000

coroa · 2026-01-08T16:52:25Z

As reported in PyPSA/powerplantmatching#276, powerplantmatching has retrieval issues. Local tests passed with d121000

Fine with me to merge then! Thanks for the assist

tgilon · 2026-01-08T18:20:23Z

As reported in PyPSA/powerplantmatching#276, powerplantmatching has retrieval issues. Local tests passed with d121000

Same on d76983c, merging now

coroa force-pushed the feat/add-windows-installer branch from c13868c to bcf3ce3 Compare December 18, 2025 11:23

coroa force-pushed the feat/add-windows-installer branch from 34204d9 to 4bf6d8a Compare January 5, 2026 18:08

coroa added 21 commits January 5, 2026 19:18

feat: add windows installer

111ccb8

fix: use python unbuffered on windows

cca7a79

fix: install git into windows environment

1521ce0

fix: windows installer needs to locate binaries first

3a57786

feat: add shell script for building windows installer

6370764

fix: Speed up uninstalling by batch removing directories first

8e12d4b

fix: gitignore installer build artifacts

a32d411

fix: small fixes to windows installer

e247c8d

fix(installer): clean up wording slightly

23aad3d

feat: bundle repository into windows installer

65cdc18

fix: make sure no spaces are in repository directory

c1b01aa

feat: add gh workflow to build and attach the windows installer to re…

e2f573d

…leases

Add documentation and release notes

3134006

Update pixi.lock

70b7287

Updates README.md

413c192

fix: remove pixi from installer name

5476bb9

fix: add INSTDIR to PATH

4a7a7ea

fix: install snakemake from open-tyndp channel

7f4b99d

feat: make pixi environment install optional

7fc3c91

fix: add version constraints

6edcc1b

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

13a809e

coroa force-pushed the feat/add-windows-installer branch from 4bf6d8a to 13a809e Compare January 5, 2026 18:20

coroa mentioned this pull request Jan 5, 2026

Fix windows compatibility and other small changes #357

Merged

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

312360e

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 .

coroa requested review from lisazeyen and tgilon January 5, 2026 20:46

tgilon reviewed Jan 6, 2026

View reviewed changes

coroa added 5 commits January 7, 2026 11:58

fix: apply suggestions from thomas

4acaff0

Apply suggestion from Thomas on windows-installer Readme

4359f3a

fix(docs): fix installation heading levels

f5b23a7

fix typo

c3746d7

Update pixi.toml

af27714

tgilon added 2 commits January 8, 2026 12:33

doc: add installer in the documentation

73b9de1

Merge branch 'master' into feat/add-windows-installer

3adcb15

tgilon added 2 commits January 8, 2026 15:21

Merge branch 'master' into feat/add-windows-installer

8305723

Conflicts: pixi.lock

chore: solve merge conflicts

d121000

Merge branch 'master' into feat/add-windows-installer

d76983c

tgilon approved these changes Jan 8, 2026

View reviewed changes

tgilon merged commit 5486e7e into master Jan 8, 2026
4 of 5 checks passed

tgilon deleted the feat/add-windows-installer branch January 8, 2026 18:20

coroa mentioned this pull request Jan 13, 2026

fix: windows installer on release tags #368

Merged

2 tasks

Uh oh!

Conversation

coroa commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed in this Pull Request

How It Works

Implementation Details

Notes

Tests

Screenshots

Installing

Shortcuts

Running

Uninstalling

Checklist

Uh oh!

coroa commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lisazeyen commented Dec 18, 2025

Uh oh!

coroa commented Dec 18, 2025

Uh oh!

coroa commented Jan 5, 2026

Uh oh!

tgilon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tgilon Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

coroa Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

coroa Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgilon Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

coroa Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgilon Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

coroa Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coroa commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coroa commented Jan 7, 2026

Uh oh!

tgilon commented Jan 7, 2026

Uh oh!

coroa commented Jan 7, 2026

Uh oh!

daniel-rdt commented Jan 8, 2026

Uh oh!

tgilon commented Jan 8, 2026

Uh oh!

daniel-rdt commented Jan 8, 2026

Uh oh!

tgilon commented Jan 8, 2026

Uh oh!

coroa commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tgilon commented Jan 8, 2026

coroa commented Dec 17, 2025 •

edited

Loading

coroa commented Dec 18, 2025 •

edited

Loading

coroa Jan 7, 2026 •

edited

Loading

coroa Jan 8, 2026 •

edited

Loading

coroa commented Jan 7, 2026 •

edited

Loading

coroa commented Jan 8, 2026 •

edited

Loading