Skip to content

docs: jupyter examples#121

Merged
cusma merged 11 commits into
actusfrom
docs/examples
Mar 13, 2026
Merged

docs: jupyter examples#121
cusma merged 11 commits into
actusfrom
docs/examples

Conversation

@cusma
Copy link
Copy Markdown
Owner

@cusma cusma commented Mar 13, 2026

No description provided.

@cusma cusma requested a review from Copilot March 13, 2026 21:11
@cusma cusma self-assigned this Mar 13, 2026
@cusma cusma added the documentation Improvements or additions to documentation label Mar 13, 2026
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds live Jupyter notebook walkthroughs demonstrating PAM bond lifecycles on AlgoKit LocalNet, and wires up repo docs/tooling to support running them.

Changes:

  • Add two notebook examples (fixed coupon + zero coupon) plus shared helper utilities.
  • Add Jupyter runtime dependencies and documentation links for running notebooks.
  • Update clean target and .gitignore to better handle notebook artifacts.

Reviewed changes

Copilot reviewed 7 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
pyproject.toml Adds Jupyter-related dependencies needed to run the new notebooks.
examples/pam_zero_coupon_bond.ipynb New LocalNet walkthrough notebook for a PAM zero coupon bond lifecycle.
examples/pam_fixed_coupon_bond.ipynb New LocalNet walkthrough notebook for a PAM fixed coupon bond lifecycle.
examples/_support.py Adds helper functions for LocalNet connection, formatting, and table rendering used by notebooks.
examples/README.md Documents how to run the notebooks and LocalNet prerequisites.
README.md Links to the notebook examples and adds a command to launch JupyterLab.
Makefile Extends clean to remove notebook checkpoints and adjusts help text.
.gitignore Ignores Jupyter .ipynb_checkpoints/ directories.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pyproject.toml
Comment thread examples/_support.py Outdated
Comment thread examples/pam_fixed_coupon_bond.ipynb Outdated
Comment thread examples/pam_fixed_coupon_bond.ipynb
Comment thread Makefile Outdated
cusma and others added 5 commits March 13, 2026 22:32
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds runnable JupyterLab notebook walkthroughs (PAM fixed/zero coupon bonds) and supporting tooling so users can launch them easily—especially via Docker—against AlgoKit LocalNet.

Changes:

  • Introduces optional Poetry dependency group notebooks and updates lockfile accordingly.
  • Adds two end-to-end LocalNet notebook examples plus shared helpers and an examples README.
  • Adds a ./d-asa jupyter command (and make jupyter-docker) and updates Dockerfile to include JupyterLab.

Reviewed changes

Copilot reviewed 14 out of 16 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
pyproject.toml Adds optional notebooks dependency group (ipykernel, jupyterlab).
poetry.lock Locks notebook dependency set and adjusts groups/markers accordingly.
examples/pam_zero_coupon_bond.ipynb New LocalNet walkthrough notebook for PAM zero coupon bond lifecycle.
examples/pam_fixed_coupon_bond.ipynb New LocalNet walkthrough notebook for PAM fixed coupon bond lifecycle.
examples/_support.py Shared helpers for connecting to LocalNet, creating accounts/assets, and rendering tables.
examples/README.md Documents how to run notebooks via Docker or locally.
docs/sdk/*.md Markdown formatting/wording cleanup and improved headings/wrapping.
d-asa Adds jupyter command to run JupyterLab in Docker with LocalNet integration.
README.md Links to notebook examples and documents notebook workflows.
Makefile Adds jupyter-docker target and extends clean to remove notebook checkpoints.
Dockerfile Installs notebook dependencies and exposes port 8888.
.gitignore Ignores .ipynb_checkpoints/.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread d-asa
Comment thread d-asa
Comment thread d-asa Outdated
Comment thread Makefile
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@cusma cusma merged commit 9744a49 into actus Mar 13, 2026
9 checks passed
@cusma cusma deleted the docs/examples branch March 13, 2026 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants