diff --git a/README.rst b/README.rst index fc408bc..5ba1845 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,33 @@ Remote IKernel -------------- -Launch IPython/Jupyter kernels on remote systems so that they can be +Launch Jupyter kernels on remote systems so that they can be used with local noteboooks. -Kernels start through interactive jobs in batch queue systems (only SGE -and SLURM at the moment) or through SSH connections. Once the kernel is +..image :: https://bitbucket.org/tdaff/remote_ikernel/raw/default/doc/kernels.png + +Kernels start through interactive jobs in batch queue systems (SGE, SLURM, +PBS...) or through SSH connections. Once the kernel is started, SSH tunnels are created for the communication ports are so the notebook can talk to the kernel as if it was local. -Commands for managing the kernels are included. +Commands for managing the kernels are included. There are also options for +managing kernels from different virtual environments or different python +implementations. + +Install with ``pip install remote_ikernel``. Requires ``notebook`` (as part +of jupyter), version 4.0 or greater and ``pexpect``. Passwordless ``ssh`` +to the remote machines is also required. + +.. note:: + + Version 0.3 of this package depends on the split Jupyter and IPython + version 4 and later when installing with pip. If you are upgrading + from an older version of IPython, Jupyter will probably migrate your + existing kernels (to `~/.local/share/jupyter/kernels/`), but not + profiles. If you need to stick with IPython 3 series, use an older + version of `remote_ikernel` or install without using pip/setuptools. -Install with ``pip install remote_ikernel``. Requires ``IPython`` version -3.0 or greater and ``pexpect``. Passwordless ``ssh`` to the remote machines -is also required. .. code:: shell @@ -46,7 +60,7 @@ is also required. .. code:: shell - # Set up kernels for all your local virtual environments that can be run + # Set up kernels for your local virtual environments that can be run # from a single notebook server. remote_ikernel manage --add \ @@ -64,6 +78,12 @@ the drop-down list in the notebook. calls ``run(`kill $(getpid())`)`` instaed of ``exit()``. +Changes for v0.3 +================ + + * Updated pip requirements to pull in the `notebook` package. Use an earlier + version if you need to use IPython 3. + Changes for v0.2 ================ diff --git a/doc/kernels.png b/doc/kernels.png new file mode 100644 index 0000000..6478903 Binary files /dev/null and b/doc/kernels.png differ diff --git a/remote_ikernel/__init__.py b/remote_ikernel/__init__.py index a362112..5d70c41 100644 --- a/remote_ikernel/__init__.py +++ b/remote_ikernel/__init__.py @@ -5,5 +5,5 @@ """ -__version__ = '0.2.11' +__version__ = '0.3.0' RIK_PREFIX = 'rik_' diff --git a/setup.py b/setup.py index 1b063e7..5ad6923 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ from distutils.core import setup setup(name='remote_ikernel', - version='0.2.11', + version='0.3.0', description='Running IPython kernels through batch queues', long_description=open('README.rst').read(), author='Tom Daff', @@ -15,7 +15,7 @@ url='https://bitbucket.org/tdaff/remote_ikernel', packages=['remote_ikernel'], scripts=['bin/remote_ikernel'], - install_requires=['ipython[notebook]<4', 'pexpect', 'tornado'], + install_requires=['notebook', 'pexpect', 'tornado'], classifiers=[ 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 3',