added two example notebooks: energy-resource-build and sudoku by tpu-brunkhorst · Pull Request #356 · PyPSA/linopy

tpu-brunkhorst · 2024-10-05T00:51:44Z

Hi - I added two notebooks to the examples folder. I didn't add links to these in the TOC or anything - up to you how you want to link them. Thanks for a great project!

for more information, see https://pre-commit.ci

tpu-brunkhorst · 2024-10-05T01:18:34Z

Closes #348

Sorry if I messed up the formatting stuff on the PR

aurelije · 2025-02-21T11:46:16Z

What happened to this PR? I took a brief look at sudoku example, it can be made more tidy, not all power of linopy got utilised. Whenever for loop is used it is unnecessary operation in linopy like tools where broadcast and group by operations exists

tpu-brunkhorst · 2025-02-21T14:39:56Z

I just contributed the example – it’s up to the linopy team to take it from here. From: Zlatan Kadragić ***@***.***> Sent: Friday, February 21, 2025 3:47 AM To: PyPSA/linopy ***@***.***> Cc: Brunkhorst, Greg ***@***.***>; Author ***@***.***> Subject: Re: [PyPSA/linopy] added two example notebooks: energy-resource-build and sudoku (PR #356) What happened to this example? I took a brief look at sudoku example, it can be made more tidy, not all power of linopy got utilised. Whenever for loop is used it is unnecessary operation in linopy like tools where broadcast and group by operations exists — Reply to this email directly, view it on GitHub<https://urldefense.com/v3/__https:/github.com/PyPSA/linopy/pull/356*issuecomment-2674338465__;Iw!!CRCbkf1f!SaQdNbcSPciqhJTP8PzBSGNmfbhLs7kRVEVDyh17582rD_fst9dQgPLwj3vkvuF9uqvOf65c6AeOGFXpFiH0mdRUh2joq8gh$>, or unsubscribe<https://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/BAHDJFM5CVKGAS77RTGS76T2Q4G2BAVCNFSM6AAAAABPM2L27WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNZUGMZTQNBWGU__;!!CRCbkf1f!SaQdNbcSPciqhJTP8PzBSGNmfbhLs7kRVEVDyh17582rD_fst9dQgPLwj3vkvuF9uqvOf65c6AeOGFXpFiH0mdRUh5bsIv57$>. You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>> [aurelije]aurelije left a comment (PyPSA/linopy#356)<https://urldefense.com/v3/__https:/github.com/PyPSA/linopy/pull/356*issuecomment-2674338465__;Iw!!CRCbkf1f!SaQdNbcSPciqhJTP8PzBSGNmfbhLs7kRVEVDyh17582rD_fst9dQgPLwj3vkvuF9uqvOf65c6AeOGFXpFiH0mdRUh2joq8gh$> What happened to this example? I took a brief look at sudoku example, it can be made more tidy, not all power of linopy got utilised. Whenever for loop is used it is unnecessary operation in linopy like tools where broadcast and group by operations exists — Reply to this email directly, view it on GitHub<https://urldefense.com/v3/__https:/github.com/PyPSA/linopy/pull/356*issuecomment-2674338465__;Iw!!CRCbkf1f!SaQdNbcSPciqhJTP8PzBSGNmfbhLs7kRVEVDyh17582rD_fst9dQgPLwj3vkvuF9uqvOf65c6AeOGFXpFiH0mdRUh2joq8gh$>, or unsubscribe<https://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/BAHDJFM5CVKGAS77RTGS76T2Q4G2BAVCNFSM6AAAAABPM2L27WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNZUGMZTQNBWGU__;!!CRCbkf1f!SaQdNbcSPciqhJTP8PzBSGNmfbhLs7kRVEVDyh17582rD_fst9dQgPLwj3vkvuF9uqvOf65c6AeOGFXpFiH0mdRUh5bsIv57$>. You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>>

codspeed-hq · 2026-07-14T10:28:17Z

Merging this PR will not alter performance

✅ 173 untouched benchmarks
⏩ 173 skipped benchmarks¹

_{Comparing tpu-brunkhorst:more_examples (266d103) with master (d701781)}

173 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

Replace the sudoku notebook's loops with idiomatic linopy: groupby for the square constraints, a broadcast MultiIndex-free mask for the hints, and a weighted sum for the grid reconstruction (aligns with v1 no-MultiIndex, PyPSA#803). Add nblink files and toctree entries for the energy-resource-build and sudoku examples. Square groupby uses use_fallback=True pending PyPSA#823.

Teach the why, not just the what: motivate the binary on/off encoding as a linearization, map each sum-constraint to its Sudoku rule, explain the groupby dimension collapse and the hint-mask broadcast, and frame use_fallback=True as a temporary PyPSA#823 workaround. Drop the unused square_index_3d and define the variable directly; trim the random-data 3D plot; fix typos and terminology.

for more information, see https://pre-commit.ci

FabianHofmann · 2026-07-14T11:46:34Z

Note

Generated by Claude

Pushed follow-up work on top of the two notebooks:

Vectorized the sudoku example per @aurelije's earlier feedback — the manual for-loops are gone: groupby for the 3x3-square constraints, a MultiIndex-free broadcast mask for the hints (aligned with the v1 no-MultiIndex direction, feat(v1): drop first-class MultiIndex — feasibility + implementation (#744) #803), and a weighted sum for the grid reconstruction.
Wired both notebooks into the docs — added .nblink files and toctree entries for energy-resource-build and sudoku.
Reworked the sudoku prose to teach the why (the binary on/off encoding as a linearization, what each sum-constraint enforces, etc.).

⚠️ Follow-up before/after merge

The square-constraint cell currently carries a temporary workaround:

sudoku.groupby(square_index).sum(use_fallback=True) == 1

use_fallback=True is needed because the default grouped-sum fast path reduces a multi-dimensional DataArray grouper over only one of its dims (bug: #823). The fix is #824. Once #824 is merged, drop use_fallback=True — sudoku.groupby(square_index).sum() == 1 will then be correct — and simplify the accompanying note in the notebook. This is noted inline in the notebook markdown as well.

Merged master brings the PyPSA#824 groupby-sum fix, so the square constraint uses plain .sum() and the temporary note is removed. Notebook re-executed end-to-end to confirm a valid solution.

for more information, see https://pre-commit.ci

- Use freq='ME' instead of deprecated 'M' in pd.date_range - Replace legacy np.random.seed/randn with np.random.default_rng (NPY002) Notebook re-executes end-to-end.

for more information, see https://pre-commit.ci

… flow

FabianHofmann · 2026-07-16T10:45:53Z

@tpu-brunkhorst I know this took ages but I now got the time to look at this. I will push one more commit on the energy resource nb and then merge this. thanks for the contribution

…d headings

tpu-brunkhorst · 2026-07-16T16:08:15Z

Fabian – thank you so much for reviewing the merging the notebooks and especially for your work on these excellent open-source tools. From: Fabian Hofmann ***@***.***> Sent: Thursday, July 16, 2026 3:46 AM To: PyPSA/linopy ***@***.***> Cc: Brunkhorst, Greg ***@***.***>; Mention ***@***.***> Subject: Re: [PyPSA/linopy] added two example notebooks: energy-resource-build and sudoku (PR #356) [https://avatars.githubusercontent.com/u/19226431?s=20&v=4]FabianHofmann left a comment (PyPSA/linopy#356)<https://urldefense.com/v3/__https:/github.com/PyPSA/linopy/pull/356*issuecomment-4990947010__;Iw!!CRCbkf1f!UtHYGejwN0UjQQlRcjCS-5JCNsNzCQO4TSj2AsZKK_bBnxfYM9cpUDrnmAvaIbyaH0yiedhBxki8hV0vaFPlsAqVwOkb1Cqg$> @tpu-brunkhorst<https://urldefense.com/v3/__https:/github.com/tpu-brunkhorst__;!!CRCbkf1f!UtHYGejwN0UjQQlRcjCS-5JCNsNzCQO4TSj2AsZKK_bBnxfYM9cpUDrnmAvaIbyaH0yiedhBxki8hV0vaFPlsAqVwDsW39Wv$> I know this took ages but I now got the time to look at this. I will push one more commit on the energy resource nb and then merge this. thanks for the contribution — Reply to this email directly, view it on GitHub<https://urldefense.com/v3/__https:/github.com/PyPSA/linopy/pull/356?email_source=notifications&email_token=BAHDJFKYHCJCPGRGSCTSONL5FCW7PA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOJZGA4TINZQGEYKM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM*issuecomment-4990947010__;Iw!!CRCbkf1f!UtHYGejwN0UjQQlRcjCS-5JCNsNzCQO4TSj2AsZKK_bBnxfYM9cpUDrnmAvaIbyaH0yiedhBxki8hV0vaFPlsAqVwDTBKjny$>, or unsubscribe<https://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/BAHDJFLBJMM3WJ5OR4HPTMT5FCW7PAVCNFSNUABFKJSXA33TNF2G64TZHMZTKMBSG43DQMBVHNEXG43VMU5TENJWG42TMOBYG4Z2C5QC__;!!CRCbkf1f!UtHYGejwN0UjQQlRcjCS-5JCNsNzCQO4TSj2AsZKK_bBnxfYM9cpUDrnmAvaIbyaH0yiedhBxki8hV0vaFPlsAqVwFM9V3G1$>. Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS<https://urldefense.com/v3/__https:/github.com/notifications/mobile/ios/BAHDJFPJS57LO2V6UP2YDK35FCW7PA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOJZGA4TINZQGEYKM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJKTGN5XXIZLSL5UW64Y__;!!CRCbkf1f!UtHYGejwN0UjQQlRcjCS-5JCNsNzCQO4TSj2AsZKK_bBnxfYM9cpUDrnmAvaIbyaH0yiedhBxki8hV0vaFPlsAqVwCsYkBl6$> and Android<https://urldefense.com/v3/__https:/github.com/notifications/mobile/android/BAHDJFOWQ5BPFFDVZNSLUOD5FCW7PA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOJZGA4TINZQGEYKM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLTGN5XXIZLSL5QW4ZDSN5UWI__;!!CRCbkf1f!UtHYGejwN0UjQQlRcjCS-5JCNsNzCQO4TSj2AsZKK_bBnxfYM9cpUDrnmAvaIbyaH0yiedhBxki8hV0vaFPlsAqVwH0zVmt0$>. Download it today! You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

added two example notebooks: energy-resource-build and sudoku

df82c3b

tpu-brunkhorst force-pushed the more_examples branch from 13ab7c0 to df82c3b Compare October 5, 2024 01:12

[pre-commit.ci] auto fixes from pre-commit.com hooks

775e7ee

for more information, see https://pre-commit.ci

FBumann mentioned this pull request May 20, 2026

docs: restructure and refresh the documentation guides #704

Draft

Merge branch 'master' into more_examples

717d1b1

FabianHofmann added 3 commits July 14, 2026 13:09

Reference groupby fix PR PyPSA#824 in sudoku use_fallback note

42f6d4f

FabianHofmann added the documentation Improvements or additions to documentation label Jul 14, 2026

[pre-commit.ci] auto fixes from pre-commit.com hooks

a91acf5

for more information, see https://pre-commit.ci

FabianHofmann and others added 8 commits July 15, 2026 20:15

Merge remote-tracking branch 'origin/master' into more_examples

9b65f1b

Drop use_fallback workaround now that groupby fix PyPSA#824 is merged

c0cc547

Merged master brings the PyPSA#824 groupby-sum fix, so the square constraint uses plain .sum() and the temporary note is removed. Notebook re-executed end-to-end to confirm a valid solution.

Merge remote-tracking branch 'fork/more_examples' into more_examples

d659c0b

[pre-commit.ci] auto fixes from pre-commit.com hooks

20bc70a

for more information, see https://pre-commit.ci

Fix energy-resource-build notebook for newer pandas/numpy

4feec6e

- Use freq='ME' instead of deprecated 'M' in pd.date_range - Replace legacy np.random.seed/randn with np.random.default_rng (NPY002) Notebook re-executes end-to-end.

Polish notebook prose: neutral voice, fix typos, consistent headings

9c3dc6d

[pre-commit.ci] auto fixes from pre-commit.com hooks

a621a17

for more information, see https://pre-commit.ci

Add result cross-check to sudoku notebook; fix sum labels and section…

f904614

… flow

FabianHofmann added 2 commits July 16, 2026 12:45

Improve energy notebook pedagogy: explain the model, tidy comments an…

fd8db2d

…d headings

Shorten energy notebook title

266d103

FabianHofmann merged commit c2607b6 into PyPSA:master Jul 16, 2026
8 of 9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

added two example notebooks: energy-resource-build and sudoku#356

added two example notebooks: energy-resource-build and sudoku#356
FabianHofmann merged 17 commits into
PyPSA:masterfrom
tpu-brunkhorst:more_examples

tpu-brunkhorst commented Oct 5, 2024

Uh oh!

tpu-brunkhorst commented Oct 5, 2024

Uh oh!

aurelije commented Feb 21, 2025 •

edited

Loading

Uh oh!

tpu-brunkhorst commented Feb 21, 2025 via email

Uh oh!

codspeed-hq Bot commented Jul 14, 2026 •

edited

Loading

Uh oh!

FabianHofmann commented Jul 14, 2026 •

edited

Loading

Uh oh!

FabianHofmann commented Jul 16, 2026

Uh oh!

Uh oh!

tpu-brunkhorst commented Jul 16, 2026 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

tpu-brunkhorst commented Oct 5, 2024

Uh oh!

tpu-brunkhorst commented Oct 5, 2024

Uh oh!

aurelije commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tpu-brunkhorst commented Feb 21, 2025 via email

Uh oh!

codspeed-hq Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

FabianHofmann commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ Follow-up before/after merge

Uh oh!

FabianHofmann commented Jul 16, 2026

Uh oh!

Uh oh!

tpu-brunkhorst commented Jul 16, 2026 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aurelije commented Feb 21, 2025 •

edited

Loading

codspeed-hq Bot commented Jul 14, 2026 •

edited

Loading

FabianHofmann commented Jul 14, 2026 •

edited

Loading