annotate README.md @ 92:9cde0dc0699e default tip

fix README.md
author aka
date Wed, 27 Jun 2018 00:10:30 +0900
parents ee031a093708
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
1 # Minimal CbC kernel for Jupyter
ee031a093708 fix README.md
aka
parents: 69
diff changeset
2 It is CbC kernel for Jupyter.
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
3
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
4 Referenced from https://github.com/brendan-rius/jupyter-c-kernel
ee031a093708 fix README.md
aka
parents: 69
diff changeset
5
ee031a093708 fix README.md
aka
parents: 69
diff changeset
6 ## Install
ee031a093708 fix README.md
aka
parents: 69
diff changeset
7
ee031a093708 fix README.md
aka
parents: 69
diff changeset
8 ### Local Jupyter
13
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
9
92
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
10
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
11
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
12 CbC install
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
13 ```
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
14 hg clone http://www.cr.ie.u-ryukyu.ac.jp/hg/CbC/CbC_gcc/
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
15 mkdir build-gcc && cd build-gcc
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
16 ../CbC_gcc/configure CFLAGS="-g3 -O0" \
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
17 --prefix=/usr/ --disable-nls \
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
18 --disable-bootstrap --enable-languages=c \
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
19 --enable-checking=tree,rtl,assert,types
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
20
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
21 make && make install
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
22 ```
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
23
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
24 after, kernel install.
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
25
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
26 ```
ee031a093708 fix README.md
aka
parents: 69
diff changeset
27 hg clone http://www.cr.ie.u-ryukyu.ac.jp/hg/Members/aka/jupyter_CbC_kernel
92
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
28 cd jupyter_CbC_kernel
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
29 pip3 install --upgrade pip jupyter ipykernel
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
30 pip3 install .
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
31 cd jupyter_CbC_kernel && install_CbC_kernel --user
9cde0dc0699e fix README.md
aka
parents: 91
diff changeset
32 cd ..
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
33 jupyter notebook
ee031a093708 fix README.md
aka
parents: 69
diff changeset
34 ```
ee031a093708 fix README.md
aka
parents: 69
diff changeset
35
ee031a093708 fix README.md
aka
parents: 69
diff changeset
36 ### Use with Docker (recommended)
13
086c0d0da045 Add docker pull in readme
Brendan Rius <brendan@omixy.com>
parents: 12
diff changeset
37
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
38 ```
ee031a093708 fix README.md
aka
parents: 69
diff changeset
39 hg clone http://www.cr.ie.u-ryukyu.ac.jp/hg/Members/aka/jupyter_CbC_kernel
ee031a093708 fix README.md
aka
parents: 69
diff changeset
40 cd jupyter_CbC_kernel
ee031a093708 fix README.md
aka
parents: 69
diff changeset
41 docker build -t aka/jupyter_cbc_kernel .
ee031a093708 fix README.md
aka
parents: 69
diff changeset
42 docker run -p 8888:8888 --name jupyter_cbc_kernel aka/jupyter_cbc_kernel start-notebook.sh
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
43
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
44 < 略 >
69
79199ce31269 Update README.md
Brendan Rius <brendan.rius@gmail.com>
parents: 67
diff changeset
45
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
46 Copy/paste this URL into your browser when you connect for the first time,
ee031a093708 fix README.md
aka
parents: 69
diff changeset
47 to login with a token:
ee031a093708 fix README.md
aka
parents: 69
diff changeset
48 http://0205e0a0e8b6:8888/?token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd&token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd
26
06e1c3c43532 Add alternative installation using wget and sh
Manoel Vilela <manoel_vilela@engineer.com>
parents: 18
diff changeset
49
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
50 ```
ee031a093708 fix README.md
aka
parents: 69
diff changeset
51
ee031a093708 fix README.md
aka
parents: 69
diff changeset
52 change host name "localhost".
ee031a093708 fix README.md
aka
parents: 69
diff changeset
53
ee031a093708 fix README.md
aka
parents: 69
diff changeset
54 and open above link "http://localhost:8888/?token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd&token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd"
ee031a093708 fix README.md
aka
parents: 69
diff changeset
55
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
56
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
57 ## Example of notebook
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
58
91
ee031a093708 fix README.md
aka
parents: 69
diff changeset
59 ![Example](Example.jpg)
19
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
60
63
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
61 ## Custom compilation flags
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
62
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
63 You can use custom compilation flags like so:
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
64
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
65 ![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
66
dcc9eecfc666 Updated README
Brendan Rius <brendan.rius@gmail.com>
parents: 62
diff changeset
67 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
68
19
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
69 ## License
92e342d23ebc Add MIT license
Brendan Rius <brendan@omixy.com>
parents: 18
diff changeset
70
41
bc0fec23eedb Fix typo
Brendan Rius <brendan@omixy.com>
parents: 32
diff changeset
71 [MIT](LICENSE.txt)