A Jupyter kernel base class in Python which includes core magic functions (including help, command and file path completion, parallel and distributed processing, downloads, and much more).
MetaKernel follows SPEC 0 for minimum supported Python and dependency versions.
See Jupyter's docs on wrapper kernels.
Additional magics can be installed within the new kernel package under a
magics subpackage.
Features
-
Basic set of line and cell magics for all kernels.
- Python magic for accessing python interpreter.
- Run kernels in parallel.
- Shell magics.
- Classroom management magics.
-
Tab completion for magics and file paths.
-
Help for magics using ? or Shift+Tab.
-
Plot magic for setting default plot behavior.
Kernels based on Metakernel
- matlab_kernel, https://github.com/Calysto/matlab_kernel
- octave_kernel, https://github.com/Calysto/octave_kernel
- calysto_scheme, https://github.com/Calysto/calysto_scheme
- calysto_processing, https://github.com/Calysto/calysto_processing
- java9_kernel, https://github.com/Bachmann1234/java9_kernel
- xonsh_kernel, https://github.com/Calysto/xonsh_kernel
- calysto_hy, https://github.com/Calysto/calysto_hy
- gnuplot_kernel, https://github.com/has2k1/gnuplot_kernel
- spylon_kernel, https://github.com/mariusvniekerk/spylon-kernel
- wolfram_kernel, https://github.com/mmatera/iwolfram
- sas_kernel, https://github.com/sassoftware/sas_kernel
- pysysh_kernel, https://github.com/Jaesin/psysh_kernel
- calysto_bash, https://github.com/Calysto/calysto_bash
- mit_scheme, https://github.com/twaclaw/mit-scheme-kernel
... and many others.
Installation
You can install Metakernel through pip:
pip install metakernel --upgrade
Installing metakernel from the
conda-forge channel can be achieved by
adding conda-forge to your channels with:
conda config --add channels conda-forge
Once the conda-forge channel has been
enabled, metakernel can be installed
with:
conda install metakernel
It is possible to list all of the versions of
metakernel available on your platform
with:
conda search metakernel --channel conda-forge
Use MetaKernel Magics in IPython
Although MetaKernel is a system for building new kernels, you can use a subset of the magics in the IPython kernel.
from metakernel import register_ipython_magics
register_ipython_magics()
Put the following in your (or a system-wide) ipython_config.py file:
# /etc/ipython/ipython_config.py
c = get_config()
startup = [
'from metakernel import register_ipython_magics',
'register_ipython_magics()',
]
c.InteractiveShellApp.exec_lines = startup
Use MetaKernel Languages in Parallel
To use a MetaKernel language in parallel, do the following:
- Make sure that the Python module
ipyparallelis installed. In the shell, type:
pip install ipyparallel
- To enable the extension in the notebook, in the shell, type:
ipcluster nbextension enable
- To start up a cluster, with 10 nodes, on a local IP address, in the shell, type:
ipcluster start --n=10 --ip=192.168.1.108
- Initialize the code to use the 10 nodes, inside the notebook from a
host kernel
MODULEandCLASSNAME(can be any metakernel kernel):
%parallel MODULE CLASSNAME
For example:
%parallel calysto_scheme CalystoScheme
- Run code in parallel, inside the notebook, type:
Execute a single line, in parallel:
%px (+ 1 1)
Or execute the entire cell, in parallel:
%%px
(* cluster_rank cluster_rank)
Results come back in a Python list (Scheme vector), in cluster_rank
order. (This will be a JSON representation in the future).
Therefore, the above would produce the result:
#10(0 1 4 9 16 25 36 49 64 81)
You can get the results back in any of the parallel magics (%px,
%%px, or %pmap) in the host kernel by accessing the variable _
(single underscore), or by using the --set_variable VARIABLE flag,
like so:
%%px --set_variable results
(* cluster_rank cluster_rank)
Then, in the next cell, you can access results.
Notice that you can use the variable cluster_rank to partition parts
of a problem so that each node is working on something different.
In the examples above, use -e to evaluate the code in the host kernel
as well. Note that cluster_rank is not defined on the host machine,
and that this assumes the host kernel is the same as the parallel
machines.
Configuration
Metakernel subclasses can be configured by the user. The configuration
file name is determined by the app_name property of the subclass. For
example, in the Octave kernel, it is octave_kernel. The user of the
kernel can add an octave_kernel_config.py file to their jupyter
config path. The base MetaKernel class offers plot_settings as a
configurable trait. Subclasses can define other traits that they wish to
make configurable.
As an example:
cat ~/.jupyter/octave_kernel_config.py
# use Qt as the default backend for plots
c.OctaveKernel.plot_settings = dict(backend='qt')
Documentation
Example notebooks can be viewed here.
Documentation is available online. Magics have interactive help (and online).
For version information, see the Changelog.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file metakernel-1.0.7.tar.gz.
File metadata
- Download URL: metakernel-1.0.7.tar.gz
- Upload date:
- Size: 238.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
499a0e399e353e0fb4a74e105ea2ad2aed89a15053a299f5fa93c027d721743a
|
|
| MD5 |
166a500858081fd3caf3872a66ab8b12
|
|
| BLAKE2b-256 |
9495c3e6312e8135ac099d755d50b4f579b3c7c359c2fe5d04828f7b8479643e
|
File details
Details for the file metakernel-1.0.7-py3-none-any.whl.
File metadata
- Download URL: metakernel-1.0.7-py3-none-any.whl
- Upload date:
- Size: 206.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
75318777e5b7e80c59e9732e9b9b1ac11c85b337f7c9375dfb7a3acce03b936a
|
|
| MD5 |
7c28f394c41f42e7d917d43ad64a1f9b
|
|
| BLAKE2b-256 |
161753bdb8b19607336d15b1004dc0b8f032c47aa08d8bc31a6f1fab26983207
|
