Mercurial > hg > Members > aka > jupyter_CbC_kernel

annotate README.md @ 19:92e342d23ebc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add MIT license
author Brendan Rius <brendan@omixy.com>
date Fri, 29 Apr 2016 09:52:03 +0100
parents f41ac6ca0caa
children ee3ac764f5f0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
1 # Minimal C kernel for Jupyter
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
2
16
63084d5da27c Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents: 13
diff changeset
3 ## Use with Docker (recommended)
13
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
4
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
5 * `docker pull brendanrius/jupyter-c-kernel`
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
6 * `docker run -d -p 8888:8888 brendanrius/jupyter-c-kernel`
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
7 * Go to [http://localhost:8888](http://localhost:8888) (or your VM address if you are using Docker Machine)
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
8
16
63084d5da27c Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents: 13
diff changeset
9 ## Manual installation
63084d5da27c Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents: 13
diff changeset
10
17
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
11 * Make sure you have the following requirements installed:
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
12 * gcc
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
13 * jupyter
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
14 * python
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
15 * pip
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
16 * `git clone git@github.com:brendan-rius/jupyter-c-kernel.git`
10
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
17 * `pip install jupyter-c-kernel`
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
18 * `cd jupyter-c-kernel`
16
63084d5da27c Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents: 13
diff changeset
19 * `jupyter-kernelspec install c_spec/`
18
f41ac6ca0caa Update README.md
Brendan Rius <brendan@omixy.com>
parents: 17
diff changeset
20 * `jupyter-notebook`. Enjoy!
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
21
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
22 ## Example of notebook
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
23
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
24 ![Example of notebook](example-notebook.png?raw=true "Example of notebook")
19
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
25
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
26 ## License
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
27
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
28 [MIT](LICENSE.txt)