Skip to content

Conversation

@edwardchalstrey1
Copy link
Member

@edwardchalstrey1 edwardchalstrey1 commented Sep 2, 2025

Changes

  • Restructures the PyGambit user guide into a set of notebook tutorials, which are rendered in the docs but can also be run locally by cloning the gambit repo
  • Tutorial content is adapted from the user guide but takes a sequential approach to introducing the PyGambit API functionality. The first 3 introductory tutorials should be understandable to someone without game theory knowledge or experience with Gambit, as is explained in the docs
  • Closes [Documentation]: Idea: Interactive version of PyGambit user guide/examples #542 - following this format it should be simple to add new tutorials going forward

Reviewers

  • Please review PyGambit docs for this PR build compared with current release
  • I would suggest someone has a full read through of all the tutorials: all of the sections of the original documentation should still be included as part of one tutorial or another, with the exception of "Lifetime of a game object and its elements" which I removed since I felt it was just explaining a concept in Python, not a specific PyGambit feature - happy to restore it if it feels important!

TODO

…e server when doing local development to docs
@edwardchalstrey1 edwardchalstrey1 changed the title [WIP] Convert PyGambit user guide to Jupyter notebook tutorials Refresh PyGambit user guide and add interactive Jupyter notebook option Sep 10, 2025
@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review September 10, 2025 16:04
@edwardchalstrey1 edwardchalstrey1 moved this from In progress to In review in Ed Chalstrey Gambit priorities Sep 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation]: Idea: Interactive version of PyGambit user guide/examples

2 participants