Skip to content

Commit f40ee93

Browse files
committed
README: Update installation instructions
1 parent ea0a2c0 commit f40ee93

File tree

1 file changed

+44
-46
lines changed

1 file changed

+44
-46
lines changed

README.md

Lines changed: 44 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -21,67 +21,53 @@ https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab
2121
### Requirements
2222

2323
* [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)
2724

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.
2926

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.
3331

3432
* [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).
3633

37-
```
38-
gem specific_install https://github.com/SciRuby/iruby
39-
```
4034

41-
### Ubuntu
35+
### Installing Jupyter Notebook and/or JupyterLab
4236

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
4443

4544
#### Ubuntu 17+
4645

4746
```shell
4847
sudo apt install libtool libffi-dev ruby ruby-dev make
49-
sudo apt install libzmq3-dev libczmq-dev
5048

51-
gem install ffi-rzmq
52-
gem install iruby --pre
49+
gem install --user-install iruby
5350
iruby register --force
5451
```
5552

5653
#### Ubuntu 16
5754

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.
5958

6059
```shell
6160
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
6962
iruby register --force
7063
```
7164

7265
### Windows
7366

74-
Install git and Jupyter.
7567
[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
7668

77-
Install ZeroMQ.
78-
```shell
79-
pacman -S mingw64/mingw-w64-x86_64-zeromq
80-
```
81-
8269
```shell
83-
gem install ffi-rzmq
84-
gem install iruby --pre
70+
gem install iruby
8571
iruby register --force
8672
```
8773

@@ -93,17 +79,7 @@ Install Jupyter.
9379
#### Homebrew
9480

9581
```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
10783
iruby register --force
10884
```
10985

@@ -113,8 +89,8 @@ If you are using macports, run the following commands.
11389

11490
```shell
11591
port install libtool autoconf automake autogen
116-
gem install ffi-rzmq
11792
gem install iruby
93+
iruby register --force
11894
```
11995

12096
### Docker
@@ -123,15 +99,14 @@ Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks).
12399
Running jupyter notebook:
124100

125101
```shell
126-
docker run -p 8888:8888 rubydata/datascience-notebook
102+
docker run --rm -it -p 8888:8888 rubydata/datascience-notebook
127103
```
128104

129105
### Installation for JRuby
130106

131107
You can use Java classes in your IRuby notebook.
132108

133109
* JRuby version >= 9.0.4.0
134-
* cztop gem
135110
* iruby gem
136111

137112
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
148123
$ iruby register --force
149124
```
150125

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+
151149
## Backends
152150

153151
There are two backends: PlainBackend and PryBackend.

0 commit comments

Comments
 (0)