README.md in red_amber-0.5.0 vs README.md in red_amber-0.5.1
- old
+ new
@@ -2,35 +2,42 @@
[](https://rubygems.org/gems/red_amber)
[](https://github.com/red-data-tools/red_amber/actions/workflows/ci.yml)
[](https://codeclimate.com/github/heronshoes/red_amber/maintainability)
[](https://codeclimate.com/github/heronshoes/red_amber/test_coverage)
-[](https://heronshoes.github.io/red_amber/)
+[](https://red-data-tools.github.io/red_amber/)
[](https://github.com/red-data-tools/red_amber/discussions)
-A simple dataframe library for Ruby.
+A dataframe library for Rubyists.
- Powered by [Red Arrow](https://github.com/apache/arrow/tree/master/ruby/red-arrow)
[](https://app.element.io/#/room/#red-data-tools_en:gitter.im) [](https://rubygems.org/gems/red-arrow)
- Inspired by the dataframe library [Rover-df](https://github.com/ankane/rover)
[日本語のREADME](README.ja.md)
+## Overview
+* RedAmber is a dataframe library written in ruby. It uses columnar memory format based on [Apache Arrow](https://arrow.apache.org/).
+* Our goal is to manipulate data frames in a Ruby-like writing style using blocks and collections.
+* You can easily try RedAmber with [Dev Container](https://containers.dev/). See [RedAmber Dev Container](doc/Dev_Containers.md).
+* We have [rich document with many examples](https://red-data-tools.github.io/red_amber/) and Jupyter Notebook with 127 operation examples. See [RedAmber Dev Container](doc/Dev_Containers.md).
+
## Requirements
### Ruby
-Supported Ruby version is >= 3.0 (since RedAmber 0.3.0).
+Supported Ruby version is >= 3.0.
### Required libraries
```ruby
-gem 'red-arrow', '~> 12.0.0' # Requires Apache Arrow (see installation below)
-gem 'red-parquet', '~> 12.0.0' # Optional, if you use IO from/to parquet
-gem 'red-datasets-arrow' # Optional, if you use Red Datasets or random sampling feature
-gem 'red-arrow-numo-narray' # Optional, recommended if you use inputs from Numo::NArray
-gem 'red-arrow-activerecord' # Optional, if you use Active Record
-gem 'rover-df', '~> 0.3.0' # Optional, if you use IO from/to Rover::DataFrame
+gem 'red-arrow', '~> 12.0.0' # Requires Apache Arrow (see installation below).
+gem 'red-arrow-numo-narray' # Optional, recommended if you use inputs from Numo::NArray,
+ # or use random sampling feature.
+gem 'red-parquet', '~> 12.0.0' # Optional, if you use IO from/to parquet.
+gem 'red-datasets-arrow' # Optional, if you use Red Datasets.
+gem 'red-arrow-activerecord' # Optional, if you use Active Record.
+gem 'rover-df', # Optional, if you use IO from/to Rover::DataFrame.
```
## Installation
Install requirements before you install RedAmber.
@@ -38,21 +45,20 @@
- Apache Arrow (~> 12.0.0)
- Apache Arrow GLib (~> 12.0.0)
- Apache Parquet GLib (~> 12.0.0) # If you use IO from/to parquet
See [Apache Arrow install document](https://arrow.apache.org/install/).
-
+
- Minimum installation example for the latest Ubuntu:
```
sudo apt update
sudo apt install -y -V ca-certificates lsb-release wget
wget https://apache.jfrog.io/artifactory/arrow/$(lsb_release --id --short | tr 'A-Z' 'a-z')/apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
sudo apt install -y -V ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
sudo apt update
- sudo apt install -y -V libarrow-dev
- sudo apt install -y -V libarrow-glib-dev
+ sudo apt install -y -V libarrow-dev libarrow-glib-dev
```
- On Fedora 39 (Rawhide):
```
@@ -61,48 +67,57 @@
```
- On macOS, using Homebrew:
```
- brew install apache-arrow
- brew install apache-arrow-glib
+ brew install apache-arrow apache-arrow-glib
```
If you prepared Apache Arrow, add these lines to your Gemfile:
```ruby
gem 'red-arrow', '~> 12.0.0'
gem 'red_amber'
+gem 'red-arrow-numo-narray' # Optional, recommended if you use inputs from Numo::NArray
+ # or use random sampling feature.
gem 'red-parquet', '~> 12.0.0' # Optional, if you use IO from/to parquet
gem 'red-datasets-arrow' # Optional, recommended if you use Red Datasets
-gem 'red-arrow-numo-narray' # Optional, recommended if you use inputs from Numo::NArray
gem 'red-arrow-activerecord' # Optional, if you use Active Record
-gem 'rover-df', '~> 0.3.0' # Optional, if you use IO from/to Rover::DataFrame
+gem 'rover-df', # Optional, if you use IO from/to Rover::DataFrame.
```
And then execute `bundle install` or install them yourself such as `gem install red_amber`.
+## Development Containers
+
+This repository supports [Dev Containers](https://containers.dev/). You can create a container as a full-featured development environment for RedAmber. The environment includes Ruby, Apache Arrow, RedAmber with source tree, GitHub CLI, sample datasets and Jupyter Lab with IRuby kernel. And you don't need to worry about the change of your local environment.
+
+`.devcontainer` directory in this repository includes settings of Dev Container for RedAmber.
+Please refer [How to use Dev Containers in RedAmber](doc/Dev_Containers.md) to use it.
+
## Docker image and Jupyter Notebook
+(Notice: This feature may be removed in the future. Try Dev Container above.)
+
Docker image is available from `docker` folder. See [readme](docker/readme.md) for instruction. Integrated Jypyter notebook is in docker/notebook folder.
-You can try the contents of this README interactively by [Binder](https://mybinder.org/v2/gh/heronshoes/docker-stacks/RedAmber-binder?filepath=red-amber.ipynb).
+You can try the contents of this README interactively by [Binder](https://mybinder.org/v2/gh/heronshoes/docker-stacks/RedAmber-binder?filepath=red-amber.ipynb).
[](https://mybinder.org/v2/gh/heronshoes/docker-stacks/RedAmber-binder?filepath=red-amber.ipynb)
[RubyData Docker Stacks](https://github.com/RubyData/docker-stacks) is available as a ready-to-run Docker image containing Jupyter and useful data tools as well as RedAmber (Thanks to Kenta Murata).
## Comparison of DataFrames
-Comparison of basic features of RedAmber with Python
+Comparison of basic features of RedAmber with Python
[pandas](https://pandas.pydata.org/),
R [Tidyverse](https://www.tidyverse.org/) and
Julia [Dataframes](https://dataframes.juliadata.org/stable/) is in [DataFrame_Comparison.md](doc/DataFrame_Comparison.md) (Thanks to Benson Muite).
## Data frame in `RedAmber`
Class `RedAmber::DataFrame` represents a set of data in 2D-shape.
-Its entity is a Red Arrow's Table object.
+Its entity is a Red Arrow's Table object.
Let's load the library and try some examples.
@@ -217,24 +232,25 @@
See [Vector.md](doc/Vector.md) for details.
## Jupyter notebook
-[Examples of Red Amber](https://github.com/heronshoes/docker-stacks/blob/RedAmber-binder/binder/examples_of_red_amber.ipynb)
-([raw file](https://raw.githubusercontent.com/heronshoes/docker-stacks/RedAmber-binder/binder/examples_of_red_amber.ipynb)) shows more examples in jupyter notebook.
+We are managing the source of Jupyter Notebook in qmd format by Quarto. You can easily create Notebooks and try it with Jupyter Lab in [Dev Container](doc/Dev_Containers.md).
-You can try this notebook on [Binder](https://mybinder.org/v2/gh/heronshoes/docker-stacks/RedAmber-binder?filepath=examples_of_red_amber.ipynb).
-[](https://mybinder.org/v2/gh/heronshoes/docker-stacks/RedAmber-binder?filepath=examples_of_red_amber.ipynb)
+## Development
+The recommended way to develop RedAmber is to use Dev Container. Please refer [How to use Dev Containers in RedAmber](doc/Dev_Containers.md) to use it.
-## Development
+Otherwise run below commands after install required libraries in your local system.
```shell
git clone https://github.com/red-data-tools/red_amber.git
cd red_amber
bundle install
bundle exec rake test
```
+
+We need to pass `rake test` in development of RedAmber, but not require to pass `rake rubocop` when you make a contribution. In this project we respect your preferences in code style. However, we may unify the style during merging.
## Community
I will appreciate if you could help to improve this project. Here are a few ways you can help: