Skip to content

Minor changes to README #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Build Status](https://github.com/SciRuby/iruby/workflows/CI/badge.svg)](https://github.com/SciRuby/iruby/actions)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb)

IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
IRuby is a Ruby kernel for [Jupyter project](https://jupyter.org/).

## Try IRuby

Expand All @@ -20,23 +20,23 @@ The following URL launches JupyterLab directly on Binder.

### Requirements

* [Jupyter](https://jupyter.org)
- [Jupyter](https://jupyter.org)

The following requirements are automatically installed.

* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)
* [libzmq](https://github.com/zeromq/libzmq)
- [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)
- [libzmq](https://github.com/zeromq/libzmq)

The following dependencies are optional.

* [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend
- [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend

### Installing Jupyter Notebook and/or JupyterLab

See the official document to know how to install Jupyter Notebook and/or JupyterLab.

* <https://jupyter.readthedocs.io/en/latest/install/notebook-classic.html>
* <https://jupyter.readthedocs.io/en/latest/install.html>
- <https://jupyter.readthedocs.io/en/latest/install/notebook-classic.html>
- <https://jupyter.readthedocs.io/en/latest/install.html>

### Ubuntu

Expand Down Expand Up @@ -108,8 +108,8 @@ docker run --rm -it -p 8888:8888 rubydata/datascience-notebook

You can use Java classes in your IRuby notebook.

* JRuby version >= 9.0.4.0
* iruby gem
- JRuby version >= 9.0.4.0
- iruby gem

After installation, make sure that your `env` is set up to use jruby.

Expand Down Expand Up @@ -152,8 +152,8 @@ export IRUBY_SESSION_ADAPTER="cztop"

There are two backends: PlainBackend and PryBackend.

* PlainBackend is the default backend. It uses [IRB](https://github.com/ruby/irb).
* PryBackend uses [Pry][Pry].
- PlainBackend is the default backend. It uses [IRB](https://github.com/ruby/irb).
- PryBackend uses [Pry][Pry].

You can switch the backend to PryBackend by running the code below.

Expand All @@ -163,9 +163,9 @@ IRuby::Kernel.instance.switch_backend!(:pry)

## Notebooks

Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
Take a look at the [example notebook](https://nbviewer.jupyter.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
and the [collection of notebooks](https://github.com/SciRuby/sciruby-notebooks/) which includes a Dockerfile to create a containerized installation of iruby
and other scientific gems. You can find the prebuild image at [dockerhub](https://registry.hub.docker.com/u/minad/sciruby-notebooks/).
and other scientific gems.

## Contributing

Expand Down
Loading