Mercurial > hg > Members > aka > jupyter_CbC_kernel

annotate README.md @ 75:a1e3b056a4bd 1.2.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge pull request #40 from halfhorst/master add resources/ as package data committer: GitHub <noreply@github.com>
author Brendan Rius <brendan.rius@gmail.com>
date Wed, 24 Jan 2018 11:01:54 +0100
parents 79199ce31269
children ee031a093708
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
69
79199ce31269 Update README.md
Brendan Rius <brendan.rius@gmail.com>
parents: 67
diff changeset
17 Works only on Linux and OS X. Windows is not supported yet. If you want to use this project on Windows, please use Docker.
79199ce31269 Update README.md
Brendan Rius <brendan.rius@gmail.com>
parents: 67
diff changeset
18
79199ce31269 Update README.md
Brendan Rius <brendan.rius@gmail.com>
parents: 67
diff changeset
19
17
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
20 * Make sure you have the following requirements installed:
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
21 * gcc
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
22 * jupyter
31
b9be404d9205 Use Python 3 by default
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
23 * python 3
17
81a24c69ed60 Update README
Brendan Rius <brendan@omixy.com>
parents: 16
diff changeset
24 * pip
26
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
25
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
26 ### Step-by-step:
10
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
27 * `pip install jupyter-c-kernel`
58
8a8a9952c887 Change install procedure
Brendan Rius <brendan.rius@gmail.com>
parents: 47
diff changeset
28 * `install_c_kernel`
18
f41ac6ca0caa Update README.md
Brendan Rius <brendan@omixy.com>
parents: 17
diff changeset
29 * `jupyter-notebook`. Enjoy!
6
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
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
32
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
33 ![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
34
63
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
35 ## Custom compilation flags
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
36
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
37 You can use custom compilation flags like so:
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
38
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
39 ![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
40
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
41 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
42
32
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
43 ## Contributing
fae3b8f7cbfb Add contributing guidelines in README
Brendan Rius <brendan@omixy.com>
parents: 31
diff changeset
44
46
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
45 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
46 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
47 that:
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
48
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
49 ```bash
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
50 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
51 cd jupyter-c-kernel
47
69fc0b9c02b8 Update README.md
Brendan Rius <brendan.rius@gmail.com>
parents: 46
diff changeset
52 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
53 ```
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
54
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
55 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
56 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
57 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
58 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
59 not auto-restart.
59cf2351e933 Add instruction on how to live-edit the code
Brendan Rius <brendan@omixy.com>
parents: 42
diff changeset
60
19
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
61 ## License
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
62
41
bc0fec23eedb Fix typo
Brendan Rius <brendan@omixy.com>
parents: 32
diff changeset
63 [MIT](LICENSE.txt)