Add quantui run app and quantui setup CLI launchers - #104
Merged
Conversation
Lazy-provision ~/.quantui/app.ipynb for pip installs (no bundled notebooks tree) and start Voilà with the same flags as native launchers. Optional setup writes a quantui-app shell shortcut under ~/.local/bin. Co-authored-by: Jonathan Schultz <jonathanschultzNU@users.noreply.github.com>
When Apptainer and Jupyter server env vars are present, quantui setup also writes ~/QuantUI.ipynb for JupyterLab visibility and prints cluster-specific launch instructions. quantui run app exits early with guidance instead of starting an unreachable standalone Voila server. Co-authored-by: Jonathan Schultz <jonathanschultzNU@users.noreply.github.com>
Reformat app_launcher.py and test_cli.py to satisfy pre-commit black. Co-authored-by: Jonathan Schultz <jonathanschultzNU@users.noreply.github.com>
Compare str(bindir) against PATH entries instead of Path vs str. Co-authored-by: Jonathan Schultz <jonathanschultzNU@users.noreply.github.com>
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
2 participants
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.
Adds
quantui run appandquantui setupCLI launchers for pip-installed QuantUI, plus NCShare-aware behavior for HPC JupyterLab sessions.CLI launchers
quantui run app— starts Voilà on port 8867 using a lazily generated~/.quantui/app.ipynbquantui setup— writes the launcher notebook and aquantui-appshell shortcut in~/.local/binRequires the
[app]extra (pip install 'quantui[app]').NCShare / HPC JupyterLab
When Apptainer + Jupyter server env vars are detected (NCShare interactive sessions):
quantui setupalso writes~/QuantUI.ipynb(visible in JupyterLab's file browser) and prints cluster-specific launch instructionsquantui run appexits with code 1 and explains why standalone Voilà on a second port won't work — use Render with Voilà on~/QuantUI.ipynbor the one-liner insteadTesting
tests/test_cli.py— launcher happy paths, HPC detection, home notebook write, run-app fail-fastDocs
docs/CLI.md— NCShare / HPC section underquantui setupNCSHARE-DEPLOYMENT.mdupdated on branchcursor/ncshare-cli-setup-c6d9