Add links to Binder #42
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds Binder integration for running Julia tutorials by introducing Binder configuration files, updating tutorial metadata to include Binder links, and adding GitHub Actions workflows for converting notebooks and building the Binder container.
- Added and configured Binder-related files (postBuild, apt.txt, .jupyter config).
- Updated multiple .qmd tutorial files to include a clickable Binder link.
- Introduced workflows to synchronize notebooks and build the container image.
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| postBuild | Adds a bash script to install Quarto, code‑server, and configure VS Code, supporting the Binder build environment. |
| apt.txt | Adds a dependency (zip) required for the Binder environment. |
| QuantumToolbox.jl/*.qmd | Updates tutorial files to include a new “other-links” section with Binder links. |
| HierarchicalEOM.jl/*.qmd | Updates tutorial files to include a Binder link for interactive notebooks. |
| .jupyter/jupyter_notebook_config.py | Configures a VS Code server via Jupyter’s ServerProxy ensuring integration with Binder. |
| .github/workflows/build-notebooks.yml | Introduces an action for converting .qmd files to .ipynb notebooks and synchronizing them with the notebooks branch. |
| .github/workflows/build-notebooks-container.yml | Adds an action to build the Binder container image from the notebooks branch. |
|
albertomercurio
force-pushed
the
alberto-notebooks-action
branch
from
994ff8d to
4b96597
Compare
ytdHuang
approved these changes
May 22, 2025
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.
Checklist
Thank you for contributing to Tutorials for Quantum Toolbox in
Julia! Please make sure you have finished the following tasks before opening the PR.datewere modified for new or updated tutorials.Version Informationsection was added at the end and displays the output ofversioninfo().make render.Request for a review after you have completed all the tasks. If you have not finished them all, you can also open a Draft Pull Request to let the others know this on-going work.
Description
This PR introduces the feature of running the notebooks in Binder, as also discussed in the Quarto Documentation. This would help people approaching to QuantumToolbox.jl for the first time.
This PR adds several configuration files, used by Binder to build, together with two GitHub Action files
.qmdfiles in theQuantumToolbox.jlandHierarchicalEOM.jlfolders into.ipynbnotebook files. Then, it pushes all the.ipynbfiles and the Binder configuration files into thenotebooksbranch.notebooksbranch. This should not be done frequently, as Binder would keep pulling the container. For the moment we can activate this action manually when we think it is needed.