Mercurial > hg > Members > aka > jupyter_CbC_kernel

annotate README.md @ 67:b5fd860bd157

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README.md Remove useless VCR contributing rules committer: GitHub <noreply@github.com>
author Brendan Rius <brendan.rius@gmail.com>
date Fri, 11 Aug 2017 00:23:21 +0200
parents 37ded774d876
children 79199ce31269
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`
62
775e15a2e2de Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 60
diff changeset
6 * `docker run -p 8888:8888 brendanrius/jupyter-c-kernel`
64
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
7 * Copy the given URL containing the token, and browse to it. For instance:
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
8
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
9 ```
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
10 Copy/paste this URL into your browser when you connect for the first time,
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
11 to login with a token:
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
12 http://localhost:8888/?token=66750c80bd0788f6ba15760aadz53beb9a9fb4cf8ac15ce8
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
13 ```
13
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
14
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
15 ## 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
16
17
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
17 * Make sure you have the following requirements installed:
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
18 * gcc
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
19 * jupyter
31
b9be404d9205 Use Python 3 by default
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
20 * python 3
17
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
21 * pip
26
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
22
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
23 ### Step-by-step:
10
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
24 * `pip install jupyter-c-kernel`
58
8a8a9952c887 Change install procedure
Brendan Rius <brendan.rius@gmail.com>
parents: 47
diff changeset
25 * `install_c_kernel`
18
f41ac6ca0caa Update README.md
Brendan Rius <brendan@omixy.com>
parents: 17
diff changeset
26 * `jupyter-notebook`. Enjoy!
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
27
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
63
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
32 ## Custom compilation flags
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
33
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
34 You can use custom compilation flags like so:
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
35
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
36 ![Custom compulation flag](custom_flags.png?raw=true "Example of notebook using custom compilation flags")
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
37
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
38 Here, the `-lm` flag is passed so you can use the math library.
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
39
32
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
40 ## Contributing
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
41
46
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
42 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
43 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
44 that:
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
45
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
46 ```bash
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
47 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
48 cd jupyter-c-kernel
47
69fc0b9c02b8 Update README.md
Brendan Rius <brendan.rius@gmail.com>
parents: 46
diff changeset
49 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
50 ```
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
51
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
52 This clones the source, run the kernel, and binds the current folder (the one
64
37ded774d876 Update README typo and clarification
Jason B <jasonkingsley.brown@gmail.com>
parents: 63
diff changeset
53 you just cloned) to the corresponding folder in Docker.
46
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
54 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
55 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
56 not auto-restart.
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
57
19
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
58 ## License
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
59
41
bc0fec23eedb Fix typo
Brendan Rius <brendan@omixy.com>
parents: 32
diff changeset
60 [MIT](LICENSE.txt)