Mercurial > hg > Members > aka > jupyter_CbC_kernel

annotate README.md @ 11:ed81f9f93bde

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add basic docker instructions
author Brendan Rius <brendan@omixy.com>
date Sat, 26 Mar 2016 14:59:52 +0000
parents eee0f8bf43f5
children a804d1645b0a
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
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
3 ## Requirements
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
4
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
5 * gcc
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
6 * jupyter
10
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
7 * python
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
8 * pip
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
9
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
10 ## Installation
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
11
11
ed81f9f93bde Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents: 10
diff changeset
12 ### Manually
ed81f9f93bde Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents: 10
diff changeset
13
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
14 * `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
15 * `pip install jupyter-c-kernel`
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
16 * `cd jupyter-c-kernel`
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
17 * `jupyter-kernelspec install c_kernel`
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
18
11
ed81f9f93bde Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents: 10
diff changeset
19 ### Via Docker
ed81f9f93bde Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents: 10
diff changeset
20
ed81f9f93bde Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents: 10
diff changeset
21 * `docker build .`
ed81f9f93bde Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents: 10
diff changeset
22 * `docker run -d -p 8888:8888 CONSTRUCTED_IMAGE`
ed81f9f93bde Add basic docker instructions
Brendan Rius <brendan@omixy.com>
parents: 10
diff changeset
23 * Go to [http://localhost:8888](http://localhost:8888) (or your VM if you are using Docker Machine)
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
24 ## Usage
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
25
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
26 * Open the example notebook: `jupyter-notebook example-notebook.ipynb`
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
27 * Enjoy!
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
28
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
29 ## Example of notebook
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
30
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
31 ![Example of notebook](example-notebook.png?raw=true "Example of notebook")
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
32