Mercurial > hg > Members > aka > jupyter_CbC_kernel

comparison README.md @ 16:63084d5da27c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README.md after #2 and to move the requirements to the correct section
author Brendan Rius <brendan@omixy.com>
date Mon, 18 Apr 2016 19:52:48 -0700
parents 086c0d0da045
children 81a24c69ed60
comparison
equal deleted inserted replaced
15:0c8395598958 16:63084d5da27c
1 # Minimal C kernel for Jupyter 1 # Minimal C kernel for Jupyter
2 2
3 ## Requirements 3 ## Use with Docker (recommended)
4
5 * gcc
6 * jupyter
7 * python
8 * pip
9
10 ## Installation
11
12 ### Via Docker (recommended)
13 4
14 * `docker pull brendanrius/jupyter-c-kernel` 5 * `docker pull brendanrius/jupyter-c-kernel`
15 * `docker run -d -p 8888:8888 brendanrius/jupyter-c-kernel` 6 * `docker run -d -p 8888:8888 brendanrius/jupyter-c-kernel`
16 * Go to [http://localhost:8888](http://localhost:8888) (or your VM address if you are using Docker Machine) 7 * Go to [http://localhost:8888](http://localhost:8888) (or your VM address if you are using Docker Machine)
17 8
18 ### Manually 9 ## Manual installation
10
11 ### Requirements
12
13 * gcc
14 * jupyter
15 * python
16 * pip
17
18 ## Installation
19 19
20 * `git clone git@github.com:brendan-rius/jupyter-c-kernel.git` 20 * `git clone git@github.com:brendan-rius/jupyter-c-kernel.git`
21 * `pip install jupyter-c-kernel` 21 * `pip install jupyter-c-kernel`
22 * `cd jupyter-c-kernel` 22 * `cd jupyter-c-kernel`
23 * `jupyter-kernelspec install c_kernel` 23 * `jupyter-kernelspec install c_spec/`
24 24
25 ## Usage 25 ## Usage
26 26
27 * Open the example notebook: `jupyter-notebook example-notebook.ipynb` 27 * Open the example notebook: `jupyter-notebook example-notebook.ipynb`
28 * Enjoy! 28 * Enjoy!
29 29
30 ## Example of notebook 30 ## Example of notebook
31 31
32 ![Example of notebook](example-notebook.png?raw=true "Example of notebook") 32 ![Example of notebook](example-notebook.png?raw=true "Example of notebook")
33