{"id":13484516,"url":"https://github.com/SciRuby/iruby","last_synced_at":"2025-03-27T16:30:54.239Z","repository":{"id":28114338,"uuid":"31613113","full_name":"SciRuby/iruby","owner":"SciRuby","description":"Official gem repository: Ruby kernel for Jupyter/IPython Notebook","archived":false,"fork":false,"pushed_at":"2025-02-28T01:46:09.000Z","size":1525,"stargazers_count":912,"open_issues_count":50,"forks_count":34,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-03-27T01:00:34.142Z","etag":null,"topics":["interactive","jupyter","repl","ruby"],"latest_commit_sha":null,"homepage":"https://github.com/SciRuby/iruby","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SciRuby.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-03-03T18:05:50.000Z","updated_at":"2025-03-25T01:52:41.000Z","dependencies_parsed_at":"2024-02-08T15:56:51.514Z","dependency_job_id":"04135a32-8975-4d6a-bbbe-7778d4f06e4f","html_url":"https://github.com/SciRuby/iruby","commit_stats":{"total_commits":623,"total_committers":50,"mean_commits":12.46,"dds":0.6597110754414125,"last_synced_commit":"fe16c1b6de2463d5c5552dd64b0645bf930b5834"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciRuby%2Firuby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciRuby%2Firuby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciRuby%2Firuby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciRuby%2Firuby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SciRuby","download_url":"https://codeload.github.com/SciRuby/iruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245882286,"owners_count":20687860,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["interactive","jupyter","repl","ruby"],"created_at":"2024-07-31T17:01:25.495Z","updated_at":"2025-03-27T16:30:54.210Z","avatar_url":"https://github.com/SciRuby.png","language":"Ruby","readme":"# IRuby\n\n[![Gem Version](https://badge.fury.io/rb/iruby.svg)](https://badge.fury.io/rb/iruby)\n[![Build Status](https://github.com/SciRuby/iruby/workflows/CI/badge.svg)](https://github.com/SciRuby/iruby/actions)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb)\n\nIRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).\n\n## Try IRuby\n\nYou can try IRuby with a sample notebook on Binder (the same link as the banner placed above):\n\n\u003chttps://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb\u003e\n\nThe following URL launches JupyterLab directly on Binder.\n\n\u003chttps://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab\u003e\n\n## Installation\n\n### Requirements\n\n* [Jupyter](https://jupyter.org)\n\nThe following requirements are automatically installed.\n\n* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)\n* [libzmq](https://github.com/zeromq/libzmq)\n\nThe following dependencies are optional.\n\n* [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend\n\n### Installing Jupyter Notebook and/or JupyterLab\n\nSee the official document to know how to install Jupyter Notebook and/or JupyterLab.\n\n* \u003chttps://jupyter.readthedocs.io/en/latest/install/notebook-classic.html\u003e\n* \u003chttps://jupyter.readthedocs.io/en/latest/install.html\u003e\n\n### Ubuntu\n\n#### Ubuntu 17+\n\n```shell\nsudo apt install libtool libffi-dev ruby ruby-dev make\n\ngem install --user-install iruby\niruby register --force\n```\n\n#### Ubuntu 16\n\nThe latest IRuby requires Ruby \u003e= 2.4 while Ubuntu's official Ruby package is version 2.3.\nSo you need to install Ruby \u003e= 2.4 by yourself before preparing IRuby.\nWe recommend to use rbenv.\n\n```shell\nsudo apt install libtool libffi-dev ruby ruby-dev make\ngem install --user-install iruby\niruby register --force\n```\n\n### Fedora\n\n#### Fedora 36\n\n```shell\nsudo dnf install ruby ruby-dev make zeromq-devel\n\ngem install --user-install iruby\niruby register --force\n```\n\n### Windows\n\n[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.\n\n```shell\ngem install iruby\niruby register --force\n```\n\n### macOS\n\nInstall ruby with rbenv or rvm.\nInstall Jupyter.\n\n#### Homebrew\n\n```shell\ngem install iruby\niruby register --force\n```\n\n#### MacPorts\n\nIf you are using macports, run the following commands.\n\n```shell\nport install libtool autoconf automake autogen\ngem install iruby\niruby register --force\n```\n\n### Docker\n\nTry [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks).\nRunning jupyter notebook:\n\n```shell\ndocker run --rm -it -p 8888:8888 rubydata/datascience-notebook\n```\n\n### Installation for JRuby\n\nYou can use Java classes in your IRuby notebook.\n\n* JRuby version \u003e= 9.0.4.0\n* iruby gem\n\nAfter installation, make sure that your `env` is set up to use jruby.\n\n```shell\nenv ruby -v\n```\n\nIf you use RVM, it is enough to switch the current version to jruby.\n\nIf you have already used IRuby with a different version, you need to generate a new kernel:\n\n```shell\niruby register --force\n```\n\n### Install the development version of IRuby\n\n**Be careful to use the development version because it is usually unstable.**\n\nIf you want to install the development version of IRuby from the source code, try [specific_install](https://github.com/rdp/specific_install).\n\n```\ngem specific_install https://github.com/SciRuby/iruby\n```\n\n### Note for using with CZTop and CZMQ\n\n[CZTop](https://gitlab.com/paddor/cztop) adapter has been deprecated since IRuby version 0.7.4.\nIt will be removed after several versions.\n\nIf you want to use IRuby with CZTop, you need to install it and [CZMQ](https://github.com/zeromq/czmq).\n\nIf both ffi-rzmq and cztop are installed, ffi-rzmq is used. If you prefer cztop, set the following environment variable.\n\n```sh\nexport IRUBY_SESSION_ADAPTER=\"cztop\"\n```\n\n## Backends\n\nThere are two backends: PlainBackend and PryBackend.\n\n* PlainBackend is the default backend.  It uses [IRB](https://github.com/ruby/irb).\n* PryBackend uses [Pry][Pry].\n\nYou can switch the backend to PryBackend by running the code below.\n\n```ruby\nIRuby::Kernel.instance.switch_backend!(:pry)\n```\n\n## Notebooks\n\nTake a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)\nand the [collection of notebooks](https://github.com/SciRuby/sciruby-notebooks/) which includes a Dockerfile to create a containerized installation of iruby\nand other scientific gems. You can find the prebuild image at [dockerhub](https://registry.hub.docker.com/u/minad/sciruby-notebooks/).\n\n## Contributing\n\nContributions to IRuby are very welcome.\n\nTo former contributors\n\nIn February 2021, [IRuby became the canonical repository](https://github.com/SciRuby/iruby/issues/285) and is no longer a fork from [minrk/iruby](https://github.com/minrk/iruby). Please fork from this repository again before making pull requests.\n\n## License\n\nCopyright (c) IRuby contributors and the Ruby Science Foundation.\n\nLicensed under the [MIT](LICENSE) license.\n\n[Pry]: https://github.com/pry/pry\n","funding_links":[],"categories":["Scientific","Jupyter Kernels","Ruby","Jupyter内核","Related Resources"],"sub_categories":["Text-to-Speech-to-Text","Vector search"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSciRuby%2Firuby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSciRuby%2Firuby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSciRuby%2Firuby/lists"}