Hello community,
here is the log from the commit of package python-octave-kernel for
openSUSE:Factory checked in at 2020-06-10 00:50:01
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-octave-kernel (Old)
and /work/SRC/openSUSE:Factory/.python-octave-kernel.new.3606 (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-octave-kernel"
Wed Jun 10 00:50:01 2020 rev:5 rq:812825 version:0.32.0
Changes:
--------
---
/work/SRC/openSUSE:Factory/python-octave-kernel/python-octave-kernel.changes
2019-11-29 15:59:25.500891369 +0100
+++
/work/SRC/openSUSE:Factory/.python-octave-kernel.new.3606/python-octave-kernel.changes
2020-06-10 00:50:01.539197617 +0200
@@ -1,0 +2,8 @@
+Tue Jun 9 08:38:57 UTC 2020 - Tomáš Chvátal <[email protected]>
+
+- Update to 0.32.0:
+ * Fixes for octave5
+ * Fixes for new jupyterlab
+- Remove fix_octave5.patch
+
+-------------------------------------------------------------------
Old:
----
fix_octave5.patch
octave_kernel-0.31.0.tar.gz
New:
----
octave_kernel-0.32.0.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-octave-kernel.spec ++++++
--- /var/tmp/diff_new_pack.IpwyeV/_old 2020-06-10 00:50:02.135199176 +0200
+++ /var/tmp/diff_new_pack.IpwyeV/_new 2020-06-10 00:50:02.147199208 +0200
@@ -1,7 +1,7 @@
#
# spec file for package python-octave-kernel
#
-# Copyright (c) 2019 SUSE LINUX GmbH, Nuernberg, Germany.
+# Copyright (c) 2020 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -12,21 +12,20 @@
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.
-# Please submit bugfixes or comments via http://bugs.opensuse.org/
+# Please submit bugfixes or comments via https://bugs.opensuse.org/
+#
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
%define skip_python2 1
Name: python-octave-kernel
-Version: 0.31.0
+Version: 0.32.0
Release: 0
-License: BSD-3-Clause
Summary: A Jupyter kernel for Octave
-Url: http://github.com/Calysto/octave_kernel
+License: BSD-3-Clause
Group: Development/Languages/Python
+URL: http://github.com/Calysto/octave_kernel
Source:
https://files.pythonhosted.org/packages/source/o/octave-kernel/octave_kernel-%{version}.tar.gz
-# PATCH-FIX-UPSTREAM fix_octave5.patch -- gh#Calysto/octave_kernel#160
-Patch0: fix_octave5.patch
BuildRequires: %{python_module ipykernel}
BuildRequires: %{python_module jupyter-client >= 4.3.0}
BuildRequires: %{python_module metakernel >= 0.24.0}
@@ -38,10 +37,10 @@
BuildRequires: %{python_module jupyter_kernel_test}
BuildRequires: octave-cli
# /SECTION
+Requires: jupyter-octave-kernel = %{version}
Requires: python-ipykernel
Requires: python-jupyter-client >= 4.3.0
Requires: python-metakernel >= 0.24.0
-Requires: jupyter-octave-kernel = %{version}
Provides: python-jupyter_octave_kernel = %{version}
Obsoletes: python-jupyter_octave_kernel < %{version}
Conflicts: jupyter-octave_kernel < 0.29.0
@@ -56,6 +55,7 @@
%package -n jupyter-octave-kernel
Summary: Interactive plotting package for the Jupyter notebook
+Group: Development/Languages/Python
Requires: jupyter-notebook
Requires: python3-octave-kernel = %{version}
Provides: jupyter-octave_kernel = %{version}
@@ -69,7 +69,6 @@
%prep
%setup -q -n octave_kernel-%{version}
-%patch0 -p1
%build
%python_build
@@ -96,5 +95,4 @@
%license LICENSE.txt
%{_jupyter_kernel_dir}/octave/
-
%changelog
++++++ octave_kernel-0.31.0.tar.gz -> octave_kernel-0.32.0.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/PKG-INFO
new/octave_kernel-0.32.0/PKG-INFO
--- old/octave_kernel-0.31.0/PKG-INFO 2019-06-02 11:44:10.000000000 +0200
+++ new/octave_kernel-0.32.0/PKG-INFO 2020-05-23 11:47:41.286563200 +0200
@@ -1,152 +1,187 @@
-Metadata-Version: 1.2
-Name: octave_kernel
-Version: 0.31.0
-Summary: A Jupyter kernel for Octave.
-Home-page: http://github.com/Calysto/octave_kernel
-Maintainer: Steven Silvester
-Maintainer-email: [email protected]
-License: BSD
-Download-URL: http://github.com/Calysto/octave_kernel
-Description: An Octave kernel for Jupyter
- ============================
-
- Prerequisites
- -------------
- `Jupyter Notebook
<http://jupyter.readthedocs.org/en/latest/install.html>`_ and GNU Octave_.
-
- It is recommended to also install ``gnuplot`` for Octave to enable
inline plotting.
-
- Installation
- ------------
- To install using pip::
-
- pip install octave_kernel
-
- Add ``--user`` to install in the user-level environment instead of the
system environment.
-
- To install using conda::
-
- conda config --add channels conda-forge
- conda install octave_kernel
- conda install texinfo # For the inline documentation (shift-tab)
to appear.
-
- We require the ``octave-cli`` executable to run the kernel.
- Add that executable's directory to the ``PATH`` environment variable
or use the
- ``OCTAVE_EXECUTABLE`` to point to the executable itself.
- Note that on Octave 5 on Windows, the executable is in
``"Octave-5.x.x.x\mingw64\bin"``.
-
- We automatically install a Jupyter kernelspec when installing the
- python package. This location can be found using ``jupyter kernelspec
list``.
- If the default location is not desired, remove the directory for the
- ``octave`` kernel, and install using ``python -m octave_kernel
install``. See
- ``python -m octave_kernel install --help`` for available options.
-
- Usage
- -----
- To use the kernel, run one of:
-
- .. code:: shell
-
- jupyter notebook # or ``jupyter lab``, if available
- # In the notebook interface, select Octave from the 'New' menu
- jupyter qtconsole --kernel octave
- jupyter console --kernel octave
-
- This kernel is based on `MetaKernel
<http://pypi.python.org/pypi/metakernel>`_,
- which means it features a standard set of magics (such as ``%%html``).
For a full list of magics,
- run ``%lsmagic`` in a cell.
-
- A sample notebook is available online_.
-
-
- Configuration
- -------------
- The kernel can be configured by adding an ``octave_kernel_config.py``
file to the
- ``jupyter`` config path. The ``OctaveKernel`` class offers
``plot_settings``, ``inline_toolkit``,
- ``kernel_json``, and ``cli_options`` as configurable traits. The
available plot settings are:
- 'format', 'backend', 'width', 'height', and 'resolution'.
-
- .. code:: bash
-
- cat ~/.jupyter/octave_kernel_config.py
- # use Qt as the default backend for plots
- c.OctaveKernel.plot_settings = dict(backend='qt')
-
-
- The path to the Octave kernel JSON file can also be specified by
creating an
- ``OCTAVE_KERNEL_JSON`` environment variable.
-
- The command line options to Octave can also be specified with an
- ``OCTAVE_CLI_OPTIONS`` environment variable. The cli options be
appended to the
- default opions of ``--interactive --quiet --no-init-file``. Note
that the
- init file is explicitly called after the kernel has set ``more off``
to prevent
- a lockup when the pager is invoked in ``~/.octaverc``.
-
- The inline toolkit is the ``graphics_toolkit`` used to generate plots
for the inline
- backend. It defaults to ``gnuplot``. The different backend can be
used for inline
- plotting either by using this configuration or by using the plot magic
and putting the backend name after ``inline:``, e.g. ``plot -b inline:fltk``.
-
-
- Troubleshooting
- ---------------
-
- Kernel Times Out While Starting
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- If the kernel does not start, run the following command from a
terminal:
-
- .. code:: shell
-
- python -m octave_kernel.check
-
- This can help diagnose problems with setting up integration with
Octave. If in doubt,
- create an issue with the output of that command.
-
-
- Kernel is Not Listed
- ~~~~~~~~~~~~~~~~~~~~
- If the kernel is not listed as an available kernel, first try the
following command:
-
- .. code:: shell
-
- python -m octave_kernel install --user
-
- If the kernel is still not listed, verify that the following point to
the same
- version of python:
-
- .. code:: shell
-
- which python # use "where" if using cmd.exe
- which jupyter
-
-
- Gnuplot Error
- ~~~~~~~~~~~~~
- An error that starts with ``gnuplot> set terminal aqua enhanced
title`` can be fixed by
- adding ``setenv("GNUTERM","qt");`` to ``~/.octaverc`` on MacOS or by
installing
- ``gunplot-x11`` and using ``setenv("GNUTERM", "X11")``.
-
-
- Blank Plot
- ~~~~~~~~~~
- Specify a different format using the ``%plot -f <backend>`` magic or
using a configuration setting.
- On some systems, the default ``'png'`` produces a black plot. On
other systems ``'svg'`` produces a
- black plot.
-
-
- .. _Octave: https://www.gnu.org/software/octave/download.html
- .. _online:
http://nbviewer.ipython.org/github/Calysto/octave_kernel/blob/master/octave_kernel.ipynb
-
-Platform: Any
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Software Development
-Classifier: Topic :: System :: Shells
-Requires: metakernel (>=0.24.0)
-Requires: jupyter_client (>=4.3.0)
-Requires: ipykernel
+Metadata-Version: 2.1
+Name: octave_kernel
+Version: 0.32.0
+Summary: A Jupyter kernel for Octave.
+Home-page: http://github.com/Calysto/octave_kernel
+Maintainer: Steven Silvester
+Maintainer-email: [email protected]
+License: BSD
+Download-URL: http://github.com/Calysto/octave_kernel
+Description: An Octave kernel for Jupyter
+ ============================
+
+ .. image:: https://mybinder.org/badge_logo.svg
+ :target:
https://mybinder.org/v2/gh/Calysto/octave_kernel/master?urlpath=/lab/tree/octave_kernel.ipynb
+
+ Prerequisites
+ -------------
+ `Jupyter Notebook
<http://jupyter.readthedocs.org/en/latest/install.html>`_ and GNU Octave_.
+
+ It is recommended to also install ``gnuplot`` for Octave to enable
inline plotting.
+
+ Installation
+ ------------
+ To install using pip::
+
+ pip install octave_kernel
+
+ Add ``--user`` to install in the user-level environment instead of the
system environment.
+
+ To install using conda::
+
+ conda config --add channels conda-forge
+ conda install octave_kernel
+ conda install texinfo # For the inline documentation (shift-tab)
to appear.
+
+ We require the ``octave-cli`` executable to run the kernel.
+ Add that executable's directory to the ``PATH`` environment variable
or use the
+ ``OCTAVE_EXECUTABLE`` to point to the executable itself.
+ Note that on Octave 5 on Windows, the executable is in
``"Octave-5.x.x.x\mingw64\bin"``.
+
+ We automatically install a Jupyter kernelspec when installing the
+ python package. This location can be found using ``jupyter kernelspec
list``.
+ If the default location is not desired, remove the directory for the
+ ``octave`` kernel, and install using ``python -m octave_kernel
install``. See
+ ``python -m octave_kernel install --help`` for available options.
+
+ Usage
+ -----
+ To use the kernel, run one of:
+
+ .. code:: shell
+
+ jupyter notebook # or ``jupyter lab``, if available
+ # In the notebook interface, select Octave from the 'New' menu
+ jupyter qtconsole --kernel octave
+ jupyter console --kernel octave
+
+ This kernel is based on `MetaKernel
<http://pypi.python.org/pypi/metakernel>`_,
+ which means it features a standard set of magics (such as ``%%html``).
For a full list of magics,
+ run ``%lsmagic`` in a cell.
+
+ A sample notebook is available online_.
+
+
+ Configuration
+ -------------
+ The kernel can be configured by adding an ``octave_kernel_config.py``
file to the
+ ``jupyter`` config path. The ``OctaveKernel`` class offers
``plot_settings``, ``inline_toolkit``,
+ ``kernel_json``, and ``cli_options`` as configurable traits. The
available plot settings are:
+ 'format', 'backend', 'width', 'height', 'resolution', and 'plot_dir'.
+
+ .. code:: bash
+
+ cat ~/.jupyter/octave_kernel_config.py
+ # use Qt as the default backend for plots
+ c.OctaveKernel.plot_settings = dict(backend='qt')
+
+
+ The path to the Octave kernel JSON file can also be specified by
creating an
+ ``OCTAVE_KERNEL_JSON`` environment variable.
+
+ The command line options to Octave can also be specified with an
+ ``OCTAVE_CLI_OPTIONS`` environment variable. The cli options be
appended to the
+ default opions of ``--interactive --quiet --no-init-file``. Note
that the
+ init file is explicitly called after the kernel has set ``more off``
to prevent
+ a lockup when the pager is invoked in ``~/.octaverc``.
+
+ The inline toolkit is the ``graphics_toolkit`` used to generate plots
for the inline
+ backend. It defaults to ``gnuplot``. The different backend can be
used for inline
+ plotting either by using this configuration or by using the plot magic
and putting the backend name after ``inline:``, e.g. ``plot -b inline:fltk``.
+
+
+ Troubleshooting
+ ---------------
+
+ Kernel Times Out While Starting
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ If the kernel does not start, run the following command from a
terminal:
+
+ .. code:: shell
+
+ python -m octave_kernel.check
+
+ This can help diagnose problems with setting up integration with
Octave. If in doubt,
+ create an issue with the output of that command.
+
+
+ Kernel is Not Listed
+ ~~~~~~~~~~~~~~~~~~~~
+ If the kernel is not listed as an available kernel, first try the
following command:
+
+ .. code:: shell
+
+ python -m octave_kernel install --user
+
+ If the kernel is still not listed, verify that the following point to
the same
+ version of python:
+
+ .. code:: shell
+
+ which python # use "where" if using cmd.exe
+ which jupyter
+
+
+ Gnuplot Error
+ ~~~~~~~~~~~~~
+ An error that starts with ``gnuplot> set terminal aqua enhanced
title`` can be fixed by
+ adding ``setenv("GNUTERM","qt");`` to ``~/.octaverc`` on MacOS or by
installing
+ ``gunplot-x11`` and using ``setenv("GNUTERM", "X11")``.
+
+ Octave-Snap (Linux)
+ ~~~~~~~~~~~~~~~~~~~
+ You can check if you are using a snap version on Linux by checking the
path to your Octave
+ installation.
+
+ .. code:: shell
+
+ which octave
+
+ If the returned path has ``snap`` in it, then Octave is running in a
container and you will need to configure the kernel appropriately.
+
+ 1) Set the environment variable ``OCTAVE_EXECUTABLE="octave"``
+
+ .. code:: shell
+
+ echo export OCTAVE_EXECUTABLE=\"octave\" >> ~/.bashrc
+
+ 2) Make a directory for the temporary plot directories that the kernel
uses. This *cannot* be a hidden directory.
+
+ .. code:: shell
+
+ mkdir ~/octavePlots
+
+ 3) Set ``plot_dir`` to point to your plot directory in
``octave_kernel_config.py``.
+
+ .. code:: shell
+
+ c.OctaveKernel.plot_settings =
dict(plot_dir='<home>/octavePlots')
+
+ where ``<home>`` is the absolute path to your home directory. Do not
use ``~`` as this resolves to a different location for Octave-Snap.
+
+
+ Blank Plot
+ ~~~~~~~~~~
+ Specify a different format using the ``%plot -f <backend>`` magic or
using a configuration setting.
+ On some systems, the default ``'png'`` produces a black plot. On
other systems ``'svg'`` produces a
+ black plot.
+
+
+ .. _Octave: https://www.gnu.org/software/octave/download.html
+ .. _online:
http://nbviewer.ipython.org/github/Calysto/octave_kernel/blob/master/octave_kernel.ipynb
+
+Platform: Any
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Shells
+Requires: metakernel (>=0.24.0)
+Requires: jupyter_client (>=4.3.0)
+Requires: ipykernel
+Description-Content-Type: text/x-rst
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/README.rst
new/octave_kernel-0.32.0/README.rst
--- old/octave_kernel-0.31.0/README.rst 2019-06-02 11:43:15.000000000 +0200
+++ new/octave_kernel-0.32.0/README.rst 2020-05-23 11:47:00.000000000 +0200
@@ -1,6 +1,9 @@
An Octave kernel for Jupyter
============================
+.. image:: https://mybinder.org/badge_logo.svg
+ :target:
https://mybinder.org/v2/gh/Calysto/octave_kernel/master?urlpath=/lab/tree/octave_kernel.ipynb
+
Prerequisites
-------------
`Jupyter Notebook <http://jupyter.readthedocs.org/en/latest/install.html>`_
and GNU Octave_.
@@ -55,7 +58,7 @@
The kernel can be configured by adding an ``octave_kernel_config.py`` file to
the
``jupyter`` config path. The ``OctaveKernel`` class offers ``plot_settings``,
``inline_toolkit``,
``kernel_json``, and ``cli_options`` as configurable traits. The available
plot settings are:
-'format', 'backend', 'width', 'height', and 'resolution'.
+'format', 'backend', 'width', 'height', 'resolution', and 'plot_dir'.
.. code:: bash
@@ -116,6 +119,37 @@
adding ``setenv("GNUTERM","qt");`` to ``~/.octaverc`` on MacOS or by installing
``gunplot-x11`` and using ``setenv("GNUTERM", "X11")``.
+Octave-Snap (Linux)
+~~~~~~~~~~~~~~~~~~~
+You can check if you are using a snap version on Linux by checking the path to
your Octave
+installation.
+
+.. code:: shell
+
+ which octave
+
+If the returned path has ``snap`` in it, then Octave is running in a container
and you will need to configure the kernel appropriately.
+
+1) Set the environment variable ``OCTAVE_EXECUTABLE="octave"``
+
+.. code:: shell
+
+ echo export OCTAVE_EXECUTABLE=\"octave\" >> ~/.bashrc
+
+2) Make a directory for the temporary plot directories that the kernel uses.
This *cannot* be a hidden directory.
+
+.. code:: shell
+
+ mkdir ~/octavePlots
+
+3) Set ``plot_dir`` to point to your plot directory in
``octave_kernel_config.py``.
+
+.. code:: shell
+
+ c.OctaveKernel.plot_settings = dict(plot_dir='<home>/octavePlots')
+
+where ``<home>`` is the absolute path to your home directory. Do not use ``~``
as this resolves to a different location for Octave-Snap.
+
Blank Plot
~~~~~~~~~~
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/octave_kernel/__init__.py
new/octave_kernel-0.32.0/octave_kernel/__init__.py
--- old/octave_kernel-0.31.0/octave_kernel/__init__.py 2019-06-02
11:44:06.000000000 +0200
+++ new/octave_kernel-0.32.0/octave_kernel/__init__.py 2020-05-23
11:47:28.000000000 +0200
@@ -1,5 +1,5 @@
"""An Octave kernel for Jupyter"""
-__version__ = '0.31.0'
+__version__ = '0.32.0'
from .kernel import OctaveKernel
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/octave_kernel/kernel.py
new/octave_kernel-0.32.0/octave_kernel/kernel.py
--- old/octave_kernel-0.31.0/octave_kernel/kernel.py 2019-06-02
11:41:32.000000000 +0200
+++ new/octave_kernel-0.32.0/octave_kernel/kernel.py 2020-05-23
11:47:00.000000000 +0200
@@ -189,7 +189,7 @@
# Remove "None" keys so we can use setdefault below.
keys = ['format', 'backend', 'width', 'height', 'resolution',
- 'backend', 'name']
+ 'backend', 'name', 'plot_dir']
for key in keys:
if key in settings and settings.get(key, None) is None:
del settings[key]
@@ -200,6 +200,7 @@
settings.setdefault('height', -1)
settings.setdefault('resolution', 0)
settings.setdefault('name', 'Figure')
+ settings.setdefault('plot_dir', None)
cmds = []
if settings['backend'] == 'inline':
@@ -268,7 +269,7 @@
wid = settings['width']
hgt = settings['height']
name = settings['name']
- plot_dir = plot_dir or tempfile.mkdtemp()
+ plot_dir = plot_dir or tempfile.mkdtemp(dir=settings['plot_dir'])
plot_dir = plot_dir.replace(os.path.sep, '/')
# Do not overwrite any existing plot files.
@@ -448,9 +449,11 @@
# Attempt to get the octave executable
executable = os.environ.get('OCTAVE_EXECUTABLE', None)
if executable:
- executable = which(executable)
- if 'octave-cli' not in executable:
- raise OSError('OCTAVE_EXECUTABLE does not point to an
octave-cli file, please see README')
+ fullpath = which(executable)
+ if 'snap' not in fullpath:
+ executable = fullpath
+ if 'octave-cli' not in executable:
+ raise OSError('OCTAVE_EXECUTABLE does not point to an
octave-cli file, please see README')
else:
executable = which('octave-cli')
if not executable:
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/octave_kernel.egg-info/PKG-INFO
new/octave_kernel-0.32.0/octave_kernel.egg-info/PKG-INFO
--- old/octave_kernel-0.31.0/octave_kernel.egg-info/PKG-INFO 2019-06-02
11:44:10.000000000 +0200
+++ new/octave_kernel-0.32.0/octave_kernel.egg-info/PKG-INFO 2020-05-23
11:47:40.000000000 +0200
@@ -1,152 +1,187 @@
-Metadata-Version: 1.2
-Name: octave-kernel
-Version: 0.31.0
-Summary: A Jupyter kernel for Octave.
-Home-page: http://github.com/Calysto/octave_kernel
-Maintainer: Steven Silvester
-Maintainer-email: [email protected]
-License: BSD
-Download-URL: http://github.com/Calysto/octave_kernel
-Description: An Octave kernel for Jupyter
- ============================
-
- Prerequisites
- -------------
- `Jupyter Notebook
<http://jupyter.readthedocs.org/en/latest/install.html>`_ and GNU Octave_.
-
- It is recommended to also install ``gnuplot`` for Octave to enable
inline plotting.
-
- Installation
- ------------
- To install using pip::
-
- pip install octave_kernel
-
- Add ``--user`` to install in the user-level environment instead of the
system environment.
-
- To install using conda::
-
- conda config --add channels conda-forge
- conda install octave_kernel
- conda install texinfo # For the inline documentation (shift-tab)
to appear.
-
- We require the ``octave-cli`` executable to run the kernel.
- Add that executable's directory to the ``PATH`` environment variable
or use the
- ``OCTAVE_EXECUTABLE`` to point to the executable itself.
- Note that on Octave 5 on Windows, the executable is in
``"Octave-5.x.x.x\mingw64\bin"``.
-
- We automatically install a Jupyter kernelspec when installing the
- python package. This location can be found using ``jupyter kernelspec
list``.
- If the default location is not desired, remove the directory for the
- ``octave`` kernel, and install using ``python -m octave_kernel
install``. See
- ``python -m octave_kernel install --help`` for available options.
-
- Usage
- -----
- To use the kernel, run one of:
-
- .. code:: shell
-
- jupyter notebook # or ``jupyter lab``, if available
- # In the notebook interface, select Octave from the 'New' menu
- jupyter qtconsole --kernel octave
- jupyter console --kernel octave
-
- This kernel is based on `MetaKernel
<http://pypi.python.org/pypi/metakernel>`_,
- which means it features a standard set of magics (such as ``%%html``).
For a full list of magics,
- run ``%lsmagic`` in a cell.
-
- A sample notebook is available online_.
-
-
- Configuration
- -------------
- The kernel can be configured by adding an ``octave_kernel_config.py``
file to the
- ``jupyter`` config path. The ``OctaveKernel`` class offers
``plot_settings``, ``inline_toolkit``,
- ``kernel_json``, and ``cli_options`` as configurable traits. The
available plot settings are:
- 'format', 'backend', 'width', 'height', and 'resolution'.
-
- .. code:: bash
-
- cat ~/.jupyter/octave_kernel_config.py
- # use Qt as the default backend for plots
- c.OctaveKernel.plot_settings = dict(backend='qt')
-
-
- The path to the Octave kernel JSON file can also be specified by
creating an
- ``OCTAVE_KERNEL_JSON`` environment variable.
-
- The command line options to Octave can also be specified with an
- ``OCTAVE_CLI_OPTIONS`` environment variable. The cli options be
appended to the
- default opions of ``--interactive --quiet --no-init-file``. Note
that the
- init file is explicitly called after the kernel has set ``more off``
to prevent
- a lockup when the pager is invoked in ``~/.octaverc``.
-
- The inline toolkit is the ``graphics_toolkit`` used to generate plots
for the inline
- backend. It defaults to ``gnuplot``. The different backend can be
used for inline
- plotting either by using this configuration or by using the plot magic
and putting the backend name after ``inline:``, e.g. ``plot -b inline:fltk``.
-
-
- Troubleshooting
- ---------------
-
- Kernel Times Out While Starting
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- If the kernel does not start, run the following command from a
terminal:
-
- .. code:: shell
-
- python -m octave_kernel.check
-
- This can help diagnose problems with setting up integration with
Octave. If in doubt,
- create an issue with the output of that command.
-
-
- Kernel is Not Listed
- ~~~~~~~~~~~~~~~~~~~~
- If the kernel is not listed as an available kernel, first try the
following command:
-
- .. code:: shell
-
- python -m octave_kernel install --user
-
- If the kernel is still not listed, verify that the following point to
the same
- version of python:
-
- .. code:: shell
-
- which python # use "where" if using cmd.exe
- which jupyter
-
-
- Gnuplot Error
- ~~~~~~~~~~~~~
- An error that starts with ``gnuplot> set terminal aqua enhanced
title`` can be fixed by
- adding ``setenv("GNUTERM","qt");`` to ``~/.octaverc`` on MacOS or by
installing
- ``gunplot-x11`` and using ``setenv("GNUTERM", "X11")``.
-
-
- Blank Plot
- ~~~~~~~~~~
- Specify a different format using the ``%plot -f <backend>`` magic or
using a configuration setting.
- On some systems, the default ``'png'`` produces a black plot. On
other systems ``'svg'`` produces a
- black plot.
-
-
- .. _Octave: https://www.gnu.org/software/octave/download.html
- .. _online:
http://nbviewer.ipython.org/github/Calysto/octave_kernel/blob/master/octave_kernel.ipynb
-
-Platform: Any
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Software Development
-Classifier: Topic :: System :: Shells
-Requires: metakernel (>=0.24.0)
-Requires: jupyter_client (>=4.3.0)
-Requires: ipykernel
+Metadata-Version: 2.1
+Name: octave-kernel
+Version: 0.32.0
+Summary: A Jupyter kernel for Octave.
+Home-page: http://github.com/Calysto/octave_kernel
+Maintainer: Steven Silvester
+Maintainer-email: [email protected]
+License: BSD
+Download-URL: http://github.com/Calysto/octave_kernel
+Description: An Octave kernel for Jupyter
+ ============================
+
+ .. image:: https://mybinder.org/badge_logo.svg
+ :target:
https://mybinder.org/v2/gh/Calysto/octave_kernel/master?urlpath=/lab/tree/octave_kernel.ipynb
+
+ Prerequisites
+ -------------
+ `Jupyter Notebook
<http://jupyter.readthedocs.org/en/latest/install.html>`_ and GNU Octave_.
+
+ It is recommended to also install ``gnuplot`` for Octave to enable
inline plotting.
+
+ Installation
+ ------------
+ To install using pip::
+
+ pip install octave_kernel
+
+ Add ``--user`` to install in the user-level environment instead of the
system environment.
+
+ To install using conda::
+
+ conda config --add channels conda-forge
+ conda install octave_kernel
+ conda install texinfo # For the inline documentation (shift-tab)
to appear.
+
+ We require the ``octave-cli`` executable to run the kernel.
+ Add that executable's directory to the ``PATH`` environment variable
or use the
+ ``OCTAVE_EXECUTABLE`` to point to the executable itself.
+ Note that on Octave 5 on Windows, the executable is in
``"Octave-5.x.x.x\mingw64\bin"``.
+
+ We automatically install a Jupyter kernelspec when installing the
+ python package. This location can be found using ``jupyter kernelspec
list``.
+ If the default location is not desired, remove the directory for the
+ ``octave`` kernel, and install using ``python -m octave_kernel
install``. See
+ ``python -m octave_kernel install --help`` for available options.
+
+ Usage
+ -----
+ To use the kernel, run one of:
+
+ .. code:: shell
+
+ jupyter notebook # or ``jupyter lab``, if available
+ # In the notebook interface, select Octave from the 'New' menu
+ jupyter qtconsole --kernel octave
+ jupyter console --kernel octave
+
+ This kernel is based on `MetaKernel
<http://pypi.python.org/pypi/metakernel>`_,
+ which means it features a standard set of magics (such as ``%%html``).
For a full list of magics,
+ run ``%lsmagic`` in a cell.
+
+ A sample notebook is available online_.
+
+
+ Configuration
+ -------------
+ The kernel can be configured by adding an ``octave_kernel_config.py``
file to the
+ ``jupyter`` config path. The ``OctaveKernel`` class offers
``plot_settings``, ``inline_toolkit``,
+ ``kernel_json``, and ``cli_options`` as configurable traits. The
available plot settings are:
+ 'format', 'backend', 'width', 'height', 'resolution', and 'plot_dir'.
+
+ .. code:: bash
+
+ cat ~/.jupyter/octave_kernel_config.py
+ # use Qt as the default backend for plots
+ c.OctaveKernel.plot_settings = dict(backend='qt')
+
+
+ The path to the Octave kernel JSON file can also be specified by
creating an
+ ``OCTAVE_KERNEL_JSON`` environment variable.
+
+ The command line options to Octave can also be specified with an
+ ``OCTAVE_CLI_OPTIONS`` environment variable. The cli options be
appended to the
+ default opions of ``--interactive --quiet --no-init-file``. Note
that the
+ init file is explicitly called after the kernel has set ``more off``
to prevent
+ a lockup when the pager is invoked in ``~/.octaverc``.
+
+ The inline toolkit is the ``graphics_toolkit`` used to generate plots
for the inline
+ backend. It defaults to ``gnuplot``. The different backend can be
used for inline
+ plotting either by using this configuration or by using the plot magic
and putting the backend name after ``inline:``, e.g. ``plot -b inline:fltk``.
+
+
+ Troubleshooting
+ ---------------
+
+ Kernel Times Out While Starting
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ If the kernel does not start, run the following command from a
terminal:
+
+ .. code:: shell
+
+ python -m octave_kernel.check
+
+ This can help diagnose problems with setting up integration with
Octave. If in doubt,
+ create an issue with the output of that command.
+
+
+ Kernel is Not Listed
+ ~~~~~~~~~~~~~~~~~~~~
+ If the kernel is not listed as an available kernel, first try the
following command:
+
+ .. code:: shell
+
+ python -m octave_kernel install --user
+
+ If the kernel is still not listed, verify that the following point to
the same
+ version of python:
+
+ .. code:: shell
+
+ which python # use "where" if using cmd.exe
+ which jupyter
+
+
+ Gnuplot Error
+ ~~~~~~~~~~~~~
+ An error that starts with ``gnuplot> set terminal aqua enhanced
title`` can be fixed by
+ adding ``setenv("GNUTERM","qt");`` to ``~/.octaverc`` on MacOS or by
installing
+ ``gunplot-x11`` and using ``setenv("GNUTERM", "X11")``.
+
+ Octave-Snap (Linux)
+ ~~~~~~~~~~~~~~~~~~~
+ You can check if you are using a snap version on Linux by checking the
path to your Octave
+ installation.
+
+ .. code:: shell
+
+ which octave
+
+ If the returned path has ``snap`` in it, then Octave is running in a
container and you will need to configure the kernel appropriately.
+
+ 1) Set the environment variable ``OCTAVE_EXECUTABLE="octave"``
+
+ .. code:: shell
+
+ echo export OCTAVE_EXECUTABLE=\"octave\" >> ~/.bashrc
+
+ 2) Make a directory for the temporary plot directories that the kernel
uses. This *cannot* be a hidden directory.
+
+ .. code:: shell
+
+ mkdir ~/octavePlots
+
+ 3) Set ``plot_dir`` to point to your plot directory in
``octave_kernel_config.py``.
+
+ .. code:: shell
+
+ c.OctaveKernel.plot_settings =
dict(plot_dir='<home>/octavePlots')
+
+ where ``<home>`` is the absolute path to your home directory. Do not
use ``~`` as this resolves to a different location for Octave-Snap.
+
+
+ Blank Plot
+ ~~~~~~~~~~
+ Specify a different format using the ``%plot -f <backend>`` magic or
using a configuration setting.
+ On some systems, the default ``'png'`` produces a black plot. On
other systems ``'svg'`` produces a
+ black plot.
+
+
+ .. _Octave: https://www.gnu.org/software/octave/download.html
+ .. _online:
http://nbviewer.ipython.org/github/Calysto/octave_kernel/blob/master/octave_kernel.ipynb
+
+Platform: Any
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Shells
+Requires: metakernel (>=0.24.0)
+Requires: jupyter_client (>=4.3.0)
+Requires: ipykernel
+Description-Content-Type: text/x-rst
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/setup.cfg
new/octave_kernel-0.32.0/setup.cfg
--- old/octave_kernel-0.31.0/setup.cfg 2019-06-02 11:44:10.000000000 +0200
+++ new/octave_kernel-0.32.0/setup.cfg 2020-05-23 11:47:41.287617000 +0200
@@ -1,7 +1,7 @@
-[metadata]
-license_file = LICENSE.txt
-
-[egg_info]
-tag_build =
-tag_date = 0
-
+[metadata]
+license_file = LICENSE.txt
+
+[egg_info]
+tag_build =
+tag_date = 0
+
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/setup.py
new/octave_kernel-0.32.0/setup.py
--- old/octave_kernel-0.31.0/setup.py 2019-06-02 11:41:32.000000000 +0200
+++ new/octave_kernel-0.32.0/setup.py 2020-04-10 14:33:51.000000000 +0200
@@ -59,6 +59,7 @@
platforms=["Any"],
description=DESCRIPTION,
long_description=LONG_DESCRIPTION,
+ long_description_content_type='text/x-rst',
classifiers=list(filter(None, CLASSIFIERS.split('\n'))),
requires=REQUIRES,
install_requires=INSTALL_REQUIRES
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/octave_kernel-0.31.0/test_octave_kernel.py
new/octave_kernel-0.32.0/test_octave_kernel.py
--- old/octave_kernel-0.31.0/test_octave_kernel.py 2019-05-16
03:19:28.000000000 +0200
+++ new/octave_kernel-0.32.0/test_octave_kernel.py 2020-04-10
14:33:51.000000000 +0200
@@ -19,8 +19,8 @@
completion_samples = [
{
- 'text': 'one',
- 'matches': {'ones', 'onenormest'},
+ 'text': 'acos',
+ 'matches': {'acos', 'acosd', 'acosh'},
},
]
