Update notebook demo to run on Colab; add explanatory text#335
Merged
siddharth-krishna merged 5 commits intomainfrom Jun 9, 2025
Merged
Update notebook demo to run on Colab; add explanatory text#335siddharth-krishna merged 5 commits intomainfrom
siddharth-krishna merged 5 commits intomainfrom
Conversation
tests/notebook-demo.ipynb
Outdated
| } | ||
| ], | ||
| "source": [ | ||
| "%pip install gdx2py gamspy-base git+https://github.com/etsap-TIMES/xl2times.git" |
Collaborator
Author
There was a problem hiding this comment.
Update this after release
Member
There was a problem hiding this comment.
Should we make a release before merging this PR then?
Regression test results on commit d411ec4This comment will be updated when new commits are added to the PR. |
olejandro
approved these changes
Jun 8, 2025
tests/notebook-demo.ipynb
Outdated
Comment on lines
+319
to
+322
| "var_act = g._find_symbol(\"VAR_ACT\")\n", | ||
| "print(g._get_symtype(var_act)) # No idea what this means\n", | ||
| "# But the symbol exists in the file, it's just not a parameter\n", | ||
| "# Perhaps gdx2py doesn't support this type?" |
Collaborator
Author
There was a problem hiding this comment.
@olejandro no luck with these 2 new parameters. If I use gdxdump, I see them both having many lines of data in them. Any hints on what to extract and how to present their data?
Member
There was a problem hiding this comment.
Let's figure this out later... I'll reach out to GAMS to ask about the future of the package.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adapts the existing Jupyter notebook demo to run seamlessly on Google Colab, adds explanatory text for context, and updates setup and execution steps for both Colab and local environments.
- Convert initial code cell to markdown introductory text.
- Add Colab-specific installation and resource‐download steps.
- Insert environment‐aware path logic and expand explanatory markdown.
olejandro
reviewed
Jun 9, 2025
| "def inspect_solution():\n", | ||
| " with gdx2py.GdxFile(path.join(output_dir, \"scenario.gdx\"), gams_dir=directory) as g:\n", | ||
| " with gdx2py.GdxFile(\n", | ||
| " str(Path(output_dir) / \"scenario.gdx\"), gams_dir=directory\n", |
Member
There was a problem hiding this comment.
Suggested change
| " str(Path(output_dir) / \"scenario.gdx\"), gams_dir=directory\n", | |
| " Path(output_dir) / \"scenario.gdx\", gams_dir=directory\n", |
olejandro
reviewed
Jun 9, 2025
tests/notebook-demo.ipynb
Outdated
| } | ||
| ], | ||
| "source": [ | ||
| "g = gdx2py.GdxFile(str(Path(output_dir) / \"scenario.gdx\"), gams_dir=directory)\n", |
Member
There was a problem hiding this comment.
Suggested change
| "g = gdx2py.GdxFile(str(Path(output_dir) / \"scenario.gdx\"), gams_dir=directory)\n", | |
| "g = gdx2py.GdxFile(Path(output_dir) / \"scenario.gdx\", gams_dir=directory)\n", |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the notebook demo to work on Google Colab. It also adds some text to explain what the demo is about and what else can be done (but just a sketch, please suggest how to extend/improve it!). The Demo 3 model is downloaded from a link to my drive.
Here is a shareable link to open the notebook from this branch on Colab:
https://colab.research.google.com/github/etsap-TIMES/xl2times/blob/sid/colab-demo/tests/notebook-demo.ipynb