Mercurial > hg > Members > aka > jupyter_CbC_kernel
annotate README.md @ 16:63084d5da27c
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 |
rev | line source |
---|---|
0 | 1 # Minimal C kernel for Jupyter |
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 | 4 |
5 * `docker pull brendanrius/jupyter-c-kernel` | |
6 * `docker run -d -p 8888:8888 brendanrius/jupyter-c-kernel` | |
7 * Go to [http://localhost:8888](http://localhost:8888) (or your VM address if you are using Docker Machine) | |
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 |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
11 ### Requirements |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
12 |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
13 * gcc |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
14 * jupyter |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
15 * python |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
16 * pip |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
17 |
63084d5da27c
Update README.md after #2 and to move the requirements to the correct section
Brendan Rius <brendan@omixy.com>
parents:
13
diff
changeset
|
18 ## Installation |
11
ed81f9f93bde
Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents:
10
diff
changeset
|
19 |
0 | 20 * `git clone git@github.com:brendan-rius/jupyter-c-kernel.git` |
10 | 21 * `pip install jupyter-c-kernel` |
0 | 22 * `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
|
23 * `jupyter-kernelspec install c_spec/` |
0 | 24 |
25 ## Usage | |
26 | |
6 | 27 * Open the example notebook: `jupyter-notebook example-notebook.ipynb` |
0 | 28 * Enjoy! |
6 | 29 |
30 ## Example of notebook | |
31 | |
32 ![Example of notebook](example-notebook.png?raw=true "Example of notebook") |