Skip to content

🔧 Update environment configuration for interactive notebook execution #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
munechika-koyo merged 4 commits into from
Jun 3, 2026
Merged

🔧 Update environment configuration for interactive notebook execution #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
894d0a4
🔧 Add environment configuration for binder
munechika-koyo Jun 3, 2026
07804bd
🔧 Refactor repository URL handling in conf.py for improved clarity
munechika-koyo Jun 3, 2026
f60e17b
🔧 Update emscripten-forge channel URL in environment.yml for accuracy
munechika-koyo Jun 3, 2026
22dc7b2
📝 Update CHANGELOG for version 0.5.0: Add binder badge and notebook.l…
munechika-koyo Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .binder/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: cherab-imas-nblink-environment
channels:
- conda-forge
dependencies:
- cherab-imas
- ultraplot
2 changes: 1 addition & 1 deletion .nblink/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: cherab-imas-nblink-environment
channels:
- emscripten-forge
- https://prefix.dev/emscripten-forge-4x
- conda-forge
dependencies:
- xeus-python
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Add `UnstructGrid3D` class and integrate it into the mesh loading workflow
- Add line-of-sight (LOS) handling utilities and related test scripts
- Add [binder](https://mybinder.org/) badge and configuration for interactive notebook demos
- Add notebook.link environment configuration for interactive notebook demos for future use in documentation.

### Changed

Expand Down
8 changes: 6 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@
copyright = f"2023-{date.today().year}, {author}"
version_obj = parse(__version__)
release = version_obj.public
repository_url = "https://github.com/cherab/imas"
gh_user_repo = "cherab/imas"
repository_main_branch = "master"
repository_url = f"https://github.com/{gh_user_repo}"

# -- General configuration ---------------------------------------------------
extensions = [
Expand Down Expand Up @@ -197,7 +198,9 @@
<div class="admonition note">
This page was generated from
<a class="reference external" href="__REPOSITORY_URL__/blob/{{ env.config.linkcode_blob|e }}/{{ docname|e }}">{{ docname|e }}</a>.
<br />
<br>
Interactive online version:
<span style="white-space: nowrap;"><a href="https://mybinder.org/v2/gh/__GH_USER_REPO__/{{ env.config.release|e }}?filepath={{ docname|e }}"><img alt="Binder badge" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>.</span>
<a href="{{ env.docname.split('/')|last|e + '.ipynb' }}" class="reference download internal" download>Download notebook</a>.
<script>
if (document.location.host) {
Expand All @@ -223,3 +226,4 @@
\sphinxcode{\sphinxupquote{\strut {{ docname | escape_latex }}}} \dotfill}}
"""
nbsphinx_prolog = _nbsphinx_prolog_template.replace("__REPOSITORY_URL__", repository_url)
nbsphinx_prolog = nbsphinx_prolog.replace("__GH_USER_REPO__", gh_user_repo)
Loading