Metadata-Version: 2.1
Name: dyalog-jupyter-kernel
Version: 2.0.2
Summary: Jupyter kernel for Dyalog APL
Home-page: https://github.com/Dyalog/dyalog-jupyter-kernel
Author: Stefan Kruger
Author-email: stefan@dyalog.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ipykernel (>=6.20.0)

# Jupyter kernel for Dyalog APL

This is a [Jupyter](http://jupyter.org/) kernel for [Dyalog APL](https://www.dyalog.com/). The [wiki](https://github.com/Dyalog/dyalog-jupyter-kernel/wiki) has more details. 

For complete installation instructions from scratch on Windows, see [WINDOWS.md](WINDOWS.md) in this repository.

If you're a kernel developer, see [DEVELOPMENT.md](DEVELOPMENT.md) in this repository.

## Do you have any pre-made notebook documents?

A collection of ready-made notebooks is available [here](https://github.com/Dyalog/dyalog-jupyter-notebooks).

## Installation

### Pre-requisites:

- Python version 3.8 or later. Python can be installed in several ways. We recommend the standard download from https://www.python.org/downloads/. 
- Jupyter: see the [official documentation](https://jupyter.readthedocs.io/en/latest/install.html) for installation instructions.

### Installing the Dyalog kernel

This kernel is installable via Python's package installer, [pip](https://pip.pypa.io/en/stable/). It comes bundled with Python, but does occasionally need updating. 

In your terminal, run the follwing command:

```sh
pip install dyalog-jupyter-kernel[==2.0.1]
```

After successfully installing the kernel module itself, you need to register it with your Jupyter installation, using the following terminal command:

```sh
python -m 'dyalog_kernel' install
```

You should now be able to see the `dyalog_apl` kernel listed:
```sh
jupyter kernelspec list

Available kernels:
  python3       C:\Users\stefa\work\Jupyter\py312\share\jupyter\kernels\python3
  dyalog_apl    C:\Users\stefa\AppData\Roaming\jupyter\kernels\dyalog_apl
```

Start Jupyter:

```sh
jupyter lab # or jupyter notebook
```
and you should now see Dyalog APL amongst your kernels. Click on the Dyalog APL icon.
