Mercurial > hg > Members > aka > jupyter_CbC_kernel

annotate README.md @ 31:b9be404d9205

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use Python 3 by default
author Brendan Rius <brendan@omixy.com>
date Sat, 30 Apr 2016 11:18:38 +0100
parents ee3ac764f5f0
children fae3b8f7cbfb
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
31
b9be404d9205 Use Python 3 by default
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
14 * python 3
17
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
15 * pip
26
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
16
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
17 ### Step-by-step:
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
18 * `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
19 * `pip install jupyter-c-kernel`
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
20 * `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
21 * `jupyter-kernelspec install c_spec/`
18
f41ac6ca0caa Update README.md
Brendan Rius <brendan@omixy.com>
parents: 17
diff changeset
22 * `jupyter-notebook`. Enjoy!
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
23
26
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
24 ### Easy installation for Unix user:
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
25
27
ee3c3cb52b25 Add specials args to avoid syntax errors with wget
Manoel Vilela <manoel_vilela@engineer.com>
parents: 26
diff changeset
26 * `wget -O - https://raw.githubusercontent.com/brendan-rius/jupyter-c-kernel/master/install.sh | sh`
26
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
27
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
28 ## Example of notebook
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
29
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
30 ![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
31
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
32 ## License
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
33
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
34 [MIT](LICENSE.txt)