@@ -21,67 +21,53 @@ https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab
21
21
### Requirements
22
22
23
23
* [ Jupyter] ( https://jupyter.org )
24
- * One of the following is required
25
- * [ ffi-rzmq] ( https://github.com/chuckremes/ffi-rzmq ) and [ libzmq] ( https://github.com/zeromq/libzmq )
26
- * [ CZTop] ( https://gitlab.com/paddor/cztop ) and [ CZMQ] ( https://github.com/zeromq/czmq )
27
24
28
- If both ffi-rzmq and cztop are installed, ffi-rzmq is used. If you prefer cztop, set the following environment variable .
25
+ The following requirements are automatically installed .
29
26
30
- ``` sh
31
- export IRUBY_SESSION_ADAPTER=" cztop"
32
- ```
27
+ * [ ffi-rzmq] ( https://github.com/chuckremes/ffi-rzmq )
28
+ * [ libzmq] ( https://github.com/zeromq/libzmq )
29
+
30
+ The following dependencies are optional.
33
31
34
32
* [ Pry] [ Pry ] , if you want to use [ Pry] [ Pry ] instead of IRB for the code execution backend
35
- * If you want to install the development version of IRuby from the source code, try [ specific_install] ( https://github.com/rdp/specific_install ) .
36
33
37
- ```
38
- gem specific_install https://github.com/SciRuby/iruby
39
- ```
40
34
41
- ### Ubuntu
35
+ ### Installing Jupyter Notebook and/or JupyterLab
42
36
43
- Install Jupyter.
37
+ See the official document to know how to install Jupyter Notebook and/or JupyterLab.
38
+
39
+ * https://jupyter.readthedocs.io/en/latest/install/notebook-classic.html
40
+ * https://jupyter.readthedocs.io/en/latest/install.html
41
+
42
+ ### Ubuntu
44
43
45
44
#### Ubuntu 17+
46
45
47
46
``` shell
48
47
sudo apt install libtool libffi-dev ruby ruby-dev make
49
- sudo apt install libzmq3-dev libczmq-dev
50
48
51
- gem install ffi-rzmq
52
- gem install iruby --pre
49
+ gem install --user-install iruby
53
50
iruby register --force
54
51
```
55
52
56
53
#### Ubuntu 16
57
54
58
- CZTop requires CZMQ >= 4.0.0 and ZMQ >= 4.2.0. The official packages for Ubuntu 16.04 don't satisfy these version requrements, so you need to install from source.
55
+ The latest IRuby requires Ruby >= 2.4 while Ubuntu's official Ruby package is version 2.3.
56
+ So you need to install Ruby >= 2.4 by yourself before preparing IRuby.
57
+ We recommend to use rbenv.
59
58
60
59
``` shell
61
60
sudo apt install libtool libffi-dev ruby ruby-dev make
62
- sudo apt install git libzmq-dev autoconf pkg-config
63
- git clone https://github.com/zeromq/czmq
64
- cd czmq
65
- ./autogen.sh && ./configure && sudo make && sudo make install
66
-
67
- gem install cztop
68
- gem install iruby --pre
61
+ gem install --user-install iruby
69
62
iruby register --force
70
63
```
71
64
72
65
### Windows
73
66
74
- Install git and Jupyter.
75
67
[ DevKit] ( https://rubyinstaller.org/add-ons/devkit.html ) is necessary for building RubyGems with native C-based extensions.
76
68
77
- Install ZeroMQ.
78
- ``` shell
79
- pacman -S mingw64/mingw-w64-x86_64-zeromq
80
- ```
81
-
82
69
``` shell
83
- gem install ffi-rzmq
84
- gem install iruby --pre
70
+ gem install iruby
85
71
iruby register --force
86
72
```
87
73
@@ -93,17 +79,7 @@ Install Jupyter.
93
79
#### Homebrew
94
80
95
81
``` shell
96
- brew install automake gmp libtool wget
97
- brew install zeromq --HEAD
98
- brew install czmq --HEAD
99
- ```
100
-
101
- ``` shell
102
- # export LIBZMQ_PATH=$(brew --prefix zeromq)/lib
103
- # export LIBCZMQ_PATH=$(brew --prefix czmq)/lib
104
- # gem install cztop
105
- gem install ffi-rzmq
106
- gem install iruby --pre
82
+ gem install iruby
107
83
iruby register --force
108
84
```
109
85
@@ -113,8 +89,8 @@ If you are using macports, run the following commands.
113
89
114
90
``` shell
115
91
port install libtool autoconf automake autogen
116
- gem install ffi-rzmq
117
92
gem install iruby
93
+ iruby register --force
118
94
```
119
95
120
96
### Docker
@@ -123,15 +99,14 @@ Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks).
123
99
Running jupyter notebook:
124
100
125
101
``` shell
126
- docker run -p 8888:8888 rubydata/datascience-notebook
102
+ docker run --rm -it - p 8888:8888 rubydata/datascience-notebook
127
103
```
128
104
129
105
### Installation for JRuby
130
106
131
107
You can use Java classes in your IRuby notebook.
132
108
133
109
* JRuby version >= 9.0.4.0
134
- * cztop gem
135
110
* iruby gem
136
111
137
112
After installation, make sure that your ` env ` is set up to use jruby.
@@ -148,6 +123,29 @@ If you have already used IRuby with a different version, you need to generate a
148
123
$ iruby register --force
149
124
```
150
125
126
+ ### Install the development version of IRuby
127
+
128
+ ** Be careful to use the development version because it is usually unstable.**
129
+
130
+ If you want to install the development version of IRuby from the source code, try [ specific_install] ( https://github.com/rdp/specific_install ) .
131
+
132
+ ```
133
+ gem specific_install https://github.com/SciRuby/iruby
134
+ ```
135
+
136
+ ### Note for using with CZTop and CZMQ
137
+
138
+ [ CZTop] ( https://gitlab.com/paddor/cztop ) adapter has been deprecated since IRuby version 0.7.4.
139
+ It will be removed after several versions.
140
+
141
+ If you want to use IRuby with CZTop, you need to install it and [ CZMQ] ( https://github.com/zeromq/czmq ) .
142
+
143
+ If both ffi-rzmq and cztop are installed, ffi-rzmq is used. If you prefer cztop, set the following environment variable.
144
+
145
+ ``` sh
146
+ export IRUBY_SESSION_ADAPTER=" cztop"
147
+ ```
148
+
151
149
## Backends
152
150
153
151
There are two backends: PlainBackend and PryBackend.
0 commit comments