Mercurial > hg > Members > aka > jupyter_CbC_kernel
changeset 91:ee031a093708
fix README.md
| author | aka |
|---|---|
| date | Tue, 26 Jun 2018 14:47:51 +0900 |
| parents | 0dceb5dbea0d |
| children | 9cde0dc0699e |
| files | README.md |
| diffstat | 1 files changed, 32 insertions(+), 42 deletions(-) [+] |
line wrap: on
line diff
--- a/README.md Tue Jun 26 14:47:17 2018 +0900 +++ b/README.md Tue Jun 26 14:47:51 2018 +0900 @@ -1,36 +1,44 @@ -# Minimal C kernel for Jupyter +# Minimal CbC kernel for Jupyter +It is CbC kernel for Jupyter. -## Use with Docker (recommended) +Referenced from https://github.com/brendan-rius/jupyter-c-kernel + +## Install + +### Local Jupyter - * `docker pull brendanrius/jupyter-c-kernel` - * `docker run -p 8888:8888 brendanrius/jupyter-c-kernel` - * Copy the given URL containing the token, and browse to it. For instance: - - ``` - Copy/paste this URL into your browser when you connect for the first time, - to login with a token: - http://localhost:8888/?token=66750c80bd0788f6ba15760aadz53beb9a9fb4cf8ac15ce8 - ``` +``` +hg clone http://www.cr.ie.u-ryukyu.ac.jp/hg/Members/aka/jupyter_CbC_kernel +cd jupyter_CbC_kernel +pip install jupyter-CbC-kernel +install_CbC_kernel +jupyter notebook +``` + +### Use with Docker (recommended) -## Manual installation +``` +hg clone http://www.cr.ie.u-ryukyu.ac.jp/hg/Members/aka/jupyter_CbC_kernel +cd jupyter_CbC_kernel +docker build -t aka/jupyter_cbc_kernel . +docker run -p 8888:8888 --name jupyter_cbc_kernel aka/jupyter_cbc_kernel start-notebook.sh -Works only on Linux and OS X. Windows is not supported yet. If you want to use this project on Windows, please use Docker. - +< 略 > - * Make sure you have the following requirements installed: - * gcc - * jupyter - * python 3 - * pip + Copy/paste this URL into your browser when you connect for the first time, + to login with a token: + http://0205e0a0e8b6:8888/?token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd&token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd -### Step-by-step: - * `pip install jupyter-c-kernel` - * `install_c_kernel` - * `jupyter-notebook`. Enjoy! +``` + +change host name "localhost". + +and open above link "http://localhost:8888/?token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd&token=934058629ebd810e26f1c37a3cbb350fbb8edb95fcf4e0bd" + ## Example of notebook - + ## Custom compilation flags @@ -40,24 +48,6 @@ Here, the `-lm` flag is passed so you can use the math library. -## Contributing - -The docker image installs the kernel in editable mode, meaning that you can -change the code in real-time in Docker. For that, just run the docker box like -that: - -```bash -git clone https://github.com/brendan-rius/jupyter-c-kernel.git -cd jupyter-c-kernel -docker run -v $(pwd):/jupyter/jupyter_c_kernel/ -p 8888:8888 brendanrius/jupyter-c-kernel -``` - -This clones the source, run the kernel, and binds the current folder (the one -you just cloned) to the corresponding folder in Docker. -Now, if you change the source, it will be reflected in [http://localhost:8888](http://localhost:8888) -instantly. Do not forget to click "restart" the kernel on the page as it does -not auto-restart. - ## License [MIT](LICENSE.txt)