|
1 | | -***The current master branch and gem version >= 0.2 are compatible with IPython3/Jupyter. If you require IPython2 support, please install an older gem version < 0.2 or use the branch ipython2*** |
2 | | - |
3 | 1 | # IRuby |
4 | 2 |
|
5 | | -This is a Ruby kernel for IPython/Jupyter and is part of [SciRuby](http://sciruby.com/). You can try it at [try.jupyter.org](http://try.jupyter.org/). |
| 3 | +This is a Ruby kernel for Jupyter and is part of [SciRuby](http://sciruby.com/). |
6 | 4 |
|
7 | 5 |  |
8 | 6 |
|
9 | 7 | ### Quick start |
10 | 8 | The installation instructions are divided according to environments mainly because of ZeroMQ. |
11 | 9 |
|
12 | | -#### Ubuntu/Debian |
13 | | -At first install IPython/Jupyter. I recommend an installation using virtualenv. |
14 | | - |
15 | | - sudo apt-get install python3-dev python-virtualenv |
16 | | - virtualenv -p python3 venv |
17 | | - source venv/bin/activate |
18 | | - pip install 'ipython[notebook]' |
| 10 | +#### Ubuntu 16.04 |
| 11 | +At first install Jupyter. I recommend an installation using [Anaconda](https://www.continuum.io/downloads) Python 3.6 version. |
19 | 12 |
|
20 | 13 | After that, install the Ruby gem. |
21 | 14 |
|
22 | | - gem install cztop |
23 | | - gem install iruby |
| 15 | +```shell |
| 16 | +apt install libtool libffi-dev ruby ruby-dev make |
| 17 | +gem install cztop |
| 18 | + |
| 19 | +apt install git libzmq-dev autoconf pkg-config |
| 20 | +git clone https://github.com/zeromq/czmq |
| 21 | +cd czmq |
| 22 | +./autogen.sh && ./configure && make && make install |
| 23 | + |
| 24 | +gem install specific_install |
| 25 | +gem specific_install https://github.com/SciRuby/iruby.git |
| 26 | +iruby register --force |
| 27 | +``` |
24 | 28 |
|
25 | | -Now you can run iruby with: |
| 29 | +Now you can select Ruby kernel in Jupyter Notebook with: |
26 | 30 |
|
27 | | - iruby notebook |
| 31 | + jupyter-notebook |
28 | 32 |
|
29 | 33 | #### Windows |
30 | | -At first install IPython/Jupyter. I recommend an installation using [Enthought Canopy](https://www.enthought.com/). |
| 34 | +At first install **git** and Jupyter. I recommend an installation using [Anaconda](https://www.continuum.io/downloads). |
31 | 35 |
|
32 | | -Run two commands below: |
| 36 | +Run the following commands on **Ruby command prompt**: |
33 | 37 |
|
34 | | - gem install cztop |
35 | | - gem install iruby |
| 38 | +```shell |
| 39 | +gem install cztop |
| 40 | +gem install specific_install |
| 41 | +gem specific_install https://github.com/SciRuby/iruby.git |
| 42 | +iruby register --force |
| 43 | +``` |
36 | 44 |
|
37 | | -Now you can run iruby with: |
| 45 | +Now you can select Ruby kernel in Jupyter Notebook with: |
38 | 46 |
|
39 | | - iruby notebook |
| 47 | + jupyter-notebook |
40 | 48 |
|
41 | 49 | #### Mac |
42 | | -I recommend an installation using [Anaconda](https://store.continuum.io/cshop/anaconda/). |
| 50 | +I recommend an installation using [Anaconda](https://www.continuum.io/downloads). |
43 | 51 |
|
44 | | -After that, run three commands shown below. |
| 52 | +After that, run the following commands. |
45 | 53 |
|
46 | | - brew install libtool autoconf automake autogen |
47 | | - gem install cztop |
48 | | - gem install iruby |
| 54 | +```shell |
| 55 | +brew install rbenv automake gmp libtool wget |
| 56 | +rbenv install 2.4.0 |
| 57 | +rbenv global 2.4.0 |
| 58 | +echo 'eval "$(rbenv init -)"' >> ~/.bashrc |
| 59 | +source ~/.bashrc |
| 60 | + |
| 61 | +brew install zeromq --HEAD |
| 62 | +brew install czmq --HEAD |
| 63 | +gem install cztop |
| 64 | +gem install specific_install |
| 65 | +gem specific_install https://github.com/SciRuby/iruby.git |
| 66 | +iruby register --force |
| 67 | +``` |
49 | 68 |
|
50 | 69 | #### FreeBSD |
51 | 70 |
|
@@ -114,7 +133,7 @@ and other scientific gems. You can find the prebuild image at [dockerhub](https: |
114 | 133 |
|
115 | 134 | ### Required dependencies |
116 | 135 |
|
117 | | -* IPython/Jupyter >= 3.0.0 |
| 136 | +* Jupyter >= 3.0.0 |
118 | 137 | * Ruby >= 2.1.0 |
119 | 138 |
|
120 | 139 | If you install IRuby with CZTop, CZMQ >= 4.0.0 is added to the list above. |
|
0 commit comments