Skip to content
This repository has been archived by the owner on Jan 31, 2020. It is now read-only.

inital kernel content #17

Merged
merged 6 commits into from
Aug 3, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/concepts.md

This file was deleted.

19 changes: 19 additions & 0 deletions docs/intro_kernels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: intro-kernels
title: Introducing Kernels
---


# Introducing Kernels

Kernels are tools to run code. Kernels receive messages from the front end that contain a user's code and execute the code. The kernel then sends messages that contain the result of the executed code back to the front end. Messages are formatted as JSONs and sent using [ZeroMQ](http://zguide.zeromq.org/page:all#ZeroMQ-in-a-Hundred-Words).

![](http://ipython.readthedocs.io/en/stable/_images/other_kernels.png)


IPython provides wrappers to execute code that
have been used to develop kernels across [over 100 languages](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels). Notable examples of community-developed kernels include [xeus for C++](https://github.com/QuantStack/xeus-cling), [IJavascript](https://github.com/n-riesco/ijavascript), [IHaskell](https://github.com/gibiansky/IHaskell), [Igo](https://github.com/yunabe/lgo), [IJulia](https://github.com/JuliaLang/IJulia.jl), [IRKernel](https://github.com/IRkernel/IRkernel), and [Calysto for Octave](https://github.com/Calysto/octave_kernel).

To learn more about creating your own Jupyter Kernel, you may learn more at [Making Kernels for Jupyter](http://jupyter-client.readthedocs.io/en/latest/kernels.html). An simple example kernel
is at [dsblank/simple_kernel](https://github.com/dsblank/simple_kernel) on GitHub.
If you do create a new kernel, [please add it to our list of kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels)!
57 changes: 57 additions & 0 deletions docs/using_kernels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
id: using-kernels
title: Using Kernels
---

# Using Kernels

Kernels are installed either by installing the kernel directly or adding the
kernel with [ipykernel](https://github.com/ipython/ipykernel). Many [community-developed](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) kernels will include installation instructions in their README.md. Kernels are managed with ipykernel.

To install ipykernel with pip call:

```
pip install ipykernel
```

or with conda

```
conda install ipykernel
```

To see what kernels you have already installed:

```
jupyter kernelspec list
```

Python environments are manually added through ipykernel. To add a Python
environment, ipykernel must be installed in the environment. To add a kernel
with ipykernel that is made with a configuration file, e.g. `requirements.txt`
or `environment.yml`, you will need to install ipykernel into the environment
and install the kernel while the environment is activated.


Using pip:

```
python -m pip install ipykernel virtualenv
python -m ipykernel install
python -m virtualenv myenv
source myenv/bin/activate
pip install ipykernel
pip install -r requirements.txt
python -m ipykernel install --user --name myenv --display-name "Python (myenv)"
```

Using conda:

```
conda install ipykernel
python -m ipykernel install
conda env create -f environment.yml
source activate myenv
conda install ipykernel
python -m ipykernel install --user --name myenv --display-name "Python (myenv)"
```
5 changes: 3 additions & 2 deletions website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
"components-nteract"
],
"Concepts": [
"concepts"
"intro-kernels",
"using-kernels"
],
"Contributing": [
"design-software",
Expand All @@ -16,4 +17,4 @@
"docs-deploy"
]
}
}
}