Skip to content

Conversation

@edwardchalstrey1
Copy link
Member

@edwardchalstrey1 edwardchalstrey1 commented Jan 7, 2026

Issues closed by this PR

Description of the changes in this PR

This PR adds infrastructure and documentation for an a first version of the Catalog of games:

  • Moves all the game files from contrib/games to src/pygambit/catalog_game_files
  • Catalog games can be defined in code in src/pygambit/catalog_games.py or from file in src/pygambit/catalog.yml
  • Adds automatically generated API reference docs for all Catalog games
  • Updates all tutorials that read from EFG/NFG files to instead load from the Catalog
  • Replaces the "Sample games" header on the docs navbar with a link to the list of Catalog games in the API docs
  • Adds a script called src/pygambit/catalog_update.py (usage described in developer docs)

How to review this PR

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

…ut needing to instantiate the full game object
…to avoid circular imports issue"

This reverts commit 4d46dd5.
@edwardchalstrey1 edwardchalstrey1 changed the title [WIP] Catalog v1 Add Catalog of games Jan 27, 2026
@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review January 27, 2026 10:02
@edwardchalstrey1
Copy link
Member Author

@tturocy @rahulsavani This is now ready for review - there's a lot happening in this PR, so please take a look at the docs links I've added in the top comment of this PR which should explain how everything now works.

I'm going to create some additional feature issues for the catalog and add them to the list in #394

After your review, we can make a bunch of PRs to update the catalog entries for these purposes:

  1. To update the names and any metadata for all the games in catalog.yml (and either remove or comment out any that aren't wanted) (i.e. following the "Add game files to the catalog" guide from the Updating the games catalog page)
  2. To move games used in tests into the catalog_games.py (using the "Code games for the catalog" guide) and update the tests to load those games from the catalog

We should decide whether we want to merge this branch into master now and make those PRs there, or alternatively you could branch off enhancement/731 and make PRs that target this branch.

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.

Create initial games catalog from contrib/games

2 participants