Skip to content

Commit dbba7fa

Browse files
kozo2v0dro
authored andcommitted
Update README.md
see also #114 (comment)
1 parent 49e3a23 commit dbba7fa

File tree

1 file changed

+45
-26
lines changed

1 file changed

+45
-26
lines changed

README.md

Lines changed: 45 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,70 @@
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-
31
# IRuby
42

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/).
64

75
![Screenshot](https://cloud.githubusercontent.com/assets/50754/7956845/3fa46df8-09e3-11e5-8641-f5b8669061b5.png)
86

97
### Quick start
108
The installation instructions are divided according to environments mainly because of ZeroMQ.
119

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

2013
After that, install the Ruby gem.
2114

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+
```
2428

25-
Now you can run iruby with:
29+
Now you can select Ruby kernel in Jupyter Notebook with:
2630

27-
iruby notebook
31+
jupyter-notebook
2832

2933
#### 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).
3135

32-
Run two commands below:
36+
Run the following commands on **Ruby command prompt**:
3337

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+
```
3644

37-
Now you can run iruby with:
45+
Now you can select Ruby kernel in Jupyter Notebook with:
3846

39-
iruby notebook
47+
jupyter-notebook
4048

4149
#### 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).
4351

44-
After that, run three commands shown below.
52+
After that, run the following commands.
4553

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+
```
4968

5069
#### FreeBSD
5170

@@ -114,7 +133,7 @@ and other scientific gems. You can find the prebuild image at [dockerhub](https:
114133

115134
### Required dependencies
116135

117-
* IPython/Jupyter >= 3.0.0
136+
* Jupyter >= 3.0.0
118137
* Ruby >= 2.1.0
119138

120139
If you install IRuby with CZTop, CZMQ >= 4.0.0 is added to the list above.

0 commit comments

Comments
 (0)