Metadata-Version: 1.2
Name: octave-kernel
Version: 0.29.1
Summary: A Jupyter kernel for Octave.
Home-page: http://github.com/Calysto/octave_kernel
Maintainer: Steven Silvester
Maintainer-email: steven.silvester@ieee.org
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"``.
        
        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_.
        
        
        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
        
        
        Advanced Configuration
        ----------------------
        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.
        
        The path to the Octave kernel JSON file can be specified by creating an
         ``OCTAVE_KERNEL_JSON`` environment variable.
        
        The command line options to Octave can be specified with an
        ``OCTAVE_CLI_OPTIONS`` environment variable.  The will 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``.
        
        
        .. _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.21.2)
Requires: jupyter_client (>=4.3.0)
Requires: ipykernel
