-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
Support Jupyter Notebook #97
Merged
Merged
Conversation
This file contains 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
Support CMake
(murmuring) I really should find some time to familiarize with git command...
Serial only, will expand.
Don't know why Xeus does not route inspection calls to this method, it always routes to execute_request.
Still not really sure what this protocol version is for.
Don't know why I should include this line for xeus library rpath. It is weird that python doesn't need this.
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.
Support Jupyter Notebook / Lab UI
libyt
now supports accessing interactive mode through Jupyter Notebook or Lab. Both serial (compile throughg++
) and parallel (compile through MPI) are supported. Can run python under MPI environment, gather output to root process, act like normal Python prompt, and has auto-completion feature.Currently, this feature has only tested on local machines.
API
Use this feature through:
libyt
will stop and launch kernel ifflag_file_name
is found, and find empty port itself ifuse_connection_file
is false.If you want to specify connection info, you can refer to Connection File and the file name must be
libyt_kernel_connection.json
.How to Use?
Compile libyt
Set
-DINTERACTIVE_MODE=ON
-DJUPYTER_KERNEL=ON
Currently only supports build from CMake (version >= 3.15). It is based on
xeus-zmq
, which needs other libraries when compiling :After installing libyt, set
JUPYTER_PATH
to<libyt-install-dir>/share/jupyter
, so that jupyter knows how to find customized kernel. You can put it in.bashrc
.Getting
jupyter-client
andjupyter_libyt
Get these:
jupyter_libyt
jupyter-client >= 8.0.0
tested (not sure if7.x
will work or not)jedi
: for auto-completion. (If you have IPython, then this is probably already installed.)Set
LIBYT_KERNEL_INFO_DIR
system environment variable when launching jupyter client.jupyter_libyt
(or more precisely, the libyt kernel provisioner) uses this path to find libyt kernel and its info.jupyter-lab # or jupyter notebook
Example
An example workflow of compiling libyt in parallel mode, and launch Jupyter Notebook or Lab:
JUPYTER_PATH
:libyt
.libyt
will stop and launch the kernel)LIBYT_KERNEL_INFO_DIR
to where your application executable is. Then runjupyter-lab
orjupyter notebook
.TODO before Merge
Make getting dependencies easier by getting and installing them using CMake.libyt
defined command