Mercurial > hg > Members > aka > jupyter_CbC_kernel

annotate README.md @ 55:4a03cede4763

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge pull request #27 from spoorcc/issue-14 Fix #14: Add args magic to provide cli-args to user program committer: GitHub <noreply@github.com>
author Brendan Rius <brendan.rius@gmail.com>
date Thu, 13 Apr 2017 11:29:48 +0200
parents 69fc0b9c02b8
children 8a8a9952c887
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:
10
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
18 * `pip install jupyter-c-kernel`
42
778218c42d18 Make step-by-step installation less error prone
Brendan Rius <brendan.rius@gmail.com>
parents: 41
diff changeset
19 * `git clone https://github.com/brendan-rius/jupyter-c-kernel.git`
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
41
bc0fec23eedb Fix typo
Brendan Rius <brendan@omixy.com>
parents: 32
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
32
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
32 ## Contributing
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
33
46
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
34 The docker image installs the kernel in editable mode, meaning that you can
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
35 change the code in real-time in Docker. For that, just run the docker box like
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
36 that:
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
37
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
38 ```bash
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
39 git clone https://github.com/brendan-rius/jupyter-c-kernel.git
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
40 cd jupyter-c-kernel
47
69fc0b9c02b8 Update README.md
Brendan Rius <brendan.rius@gmail.com>
parents: 46
diff changeset
41 docker run -v $(pwd):/jupyter/jupyter_c_kernel/ -p 8888:8888 brendanrius/jupyter-c-kernel
46
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
42 ```
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
43
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
44 This clones the source, run the kernel, and binds the current folder (the one
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
45 you just cloned) to eh corresponding folder in Docker.
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
46 Now, if you change the source, it will be reflected in [http://localhost:8888](http://localhost:8888)
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
47 instantly. Do not forget to click "restart" the kernel on the page as it does
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
48 not auto-restart.
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
49
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
50 ### Version control
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
51
41
bc0fec23eedb Fix typo
Brendan Rius <brendan@omixy.com>
parents: 32
diff changeset
52 Create branches named `issue-X` where `X` is the number of the issue.
32
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
53 Rebase instead of merge.
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
54
19
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
55 ## License
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
56
41
bc0fec23eedb Fix typo
Brendan Rius <brendan@omixy.com>
parents: 32
diff changeset
57 [MIT](LICENSE.txt)