Skip to content

Catalog infrastructure updates#767

Merged
edwardchalstrey1 merged 129 commits intomasterfrom
catalog/758
Mar 25, 2026
Merged

Catalog infrastructure updates#767
edwardchalstrey1 merged 129 commits intomasterfrom
catalog/758

Conversation

@edwardchalstrey1
Copy link
Member

@edwardchalstrey1 edwardchalstrey1 commented Feb 13, 2026 •
edited
Loading

Issues closed by this PR

Closes #759
Closes #761
Closes #815

Description of the changes in this PR

This PR adds

  • The ability to filter the catalog search on attributes of Game objects
  • Adds to the documentation: pygambit API reference for catalog functions
  • Updates the Catalog page to include descriptions and download links (and hides the old "Samples" page, but this isn't removed completely)
  • Also updates the games in the catalog so far to correctly link to the Bibliography

How to review this PR

  • Review the updates to the games() function which allow filtering on attributes of Game objects
  • Review the updates to the Catalog docs page

@edwardchalstrey1
Create catalog dir and move one EFG and one NFG into it from contrib/…
90a5e36 
…games
@edwardchalstrey1
ignore catalog files copied into pygambit
83dd410
@edwardchalstrey1
add failing tests
7fc2199
@edwardchalstrey1
improve tests
3c53bea
@edwardchalstrey1
add pandas to pyproject.toml
898a916
@edwardchalstrey1
add test_catalog_load_invalid_slug
8f916db
@edwardchalstrey1
create load function
606dd8a
@edwardchalstrey1
add catalog to __init__
00beed3
@edwardchalstrey1
add games() function
64eb310
@edwardchalstrey1
refactor to define READERS once
d24befd
@edwardchalstrey1
Big refactor to get catalog files from catalog dir external to pygambit
72aade1
@edwardchalstrey1
update Makefile.am for the 2 examples we moved into the catalog so far
e7953e9
@edwardchalstrey1
update Game.comment to be Game.description in Python code
7490ae6
@edwardchalstrey1
Revert "update Game.comment to be Game.description in Python code"
ebf6829 
This reverts commit 7490ae6.
@edwardchalstrey1
Add initial update catalog script and RST page
fbf6b89
@edwardchalstrey1
rename table headers on output df from game() func
1ca3461
@edwardchalstrey1
add generating the catalog csv for docs into GH actions
bd3c1f3
@edwardchalstrey1
Revert "add generating the catalog csv for docs into GH actions"
569148c 
This reverts commit bd3c1f3.
@edwardchalstrey1
refactor update script so its run from repo root
8cf0396
@edwardchalstrey1
update readthedocs to build the catalog csv before docs build
1b20438
@edwardchalstrey1
add function which updates Makefile.am
e977e64
@edwardchalstrey1
use a proper path for CATALOG_CSV
af08d29
@edwardchalstrey1
tidy update script
cd2ffc9
@edwardchalstrey1
use explicit python executable from the virtualenv to create CSV for …
5675444 
…catalog docs table in readthedocs yml
@edwardchalstrey1
add developer doc for updating the catalog
f574223
@edwardchalstrey1
Don't update Makefile.am by default
5147278
@edwardchalstrey1
consistency in notebook comment
4b033c9
@edwardchalstrey1
demo loading from catalog in tutorial 1
b14402a
@edwardchalstrey1
load from catalog for game examples in advanced tutorials
264f7fb
@edwardchalstrey1
Try using pip instead of setuptools to ensure pyproject.toml deps ins…
0e268a2 
…talled for readthedocs build
@edwardchalstrey1 edwardchalstrey1 mentioned this pull request Mar 19, 2026
Closed
@edwardchalstrey1
Copy link
Member Author

edwardchalstrey1 commented Mar 24, 2026 •
edited
Loading

Idea:

  • Update the links in the game files to directly link to the readthedocs
  • merge Main into this branch
  • Update docs homepage with catalog?

edwardchalstrey1
edwardchalstrey1 commented Mar 24, 2026
View reviewed changes
@edwardchalstrey1 edwardchalstrey1 mentioned this pull request Mar 24, 2026
Open
2 tasks
@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review March 25, 2026 09:47
@edwardchalstrey1 edwardchalstrey1 merged commit 06018d9 into master Mar 25, 2026
26 checks passed
@edwardchalstrey1 edwardchalstrey1 deleted the catalog/758 branch March 25, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tturocy tturocy Awaiting requested review from tturocy

@rahulsavani rahulsavani Awaiting requested review from rahulsavani

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Documentation]: Add missing bibliography entries [Catalog, Documentation]: Improvements to Catalog of games docs page [Catalog] Search feature

3 participants

@edwardchalstrey1 @tturocy @rahulsavani