# ipyfernel 🔥


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

### Description

IPyfernel allows you to interact with a persistent remote IPython
kernel. It will stream text outputs like simple progress bar updates it
will communicate error messages seamlessly and image outputs. It allows
you to optionally “hijack” the code cell execution via “sticky” mode so
that cells execute remotely by default.

### Choice of Name

It’s a remote kernel, so this is a play on words: `ipykernel` + the
German word/prefix “fern” meaning “remote”. Plus it sounds a bit like
“infernal.” 🔥

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

### Install ipyfernel in Development mode

``` sh
# make sure ipyfernel package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to ipyfernel
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/drscotthawley/ipyfernel):

``` sh
$ pip install git+https://github.com/drscotthawley/ipyfernel.git
```

or from [pypi](https://pypi.org/project/ipyfernel/)

``` sh
$ pip install ipyfernel
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/drscotthawley/ipyfernel)’s
[pages](https://drscotthawley.github.io/ipyfernel/). Additionally you
can find package manager specific guidelines
[pypi](https://pypi.org/project/ipyfernel/).

## How to use

See the [demo](https://drscotthawley.github.io/ipyfernel/demo.html) for
examples.

**TODO:** Add more examples!