Skip to content

Commit 0b5e6eb

Browse files
committed
actualize readme and travis config
1 parent bba9f93 commit 0b5e6eb

File tree

2 files changed

+39
-36
lines changed

2 files changed

+39
-36
lines changed

.travis.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
notifications:
22
email: false
33
language: ruby
4+
sudo: required
45
rvm:
5-
- ruby-2.0
6-
- ruby-2.1.5
7-
- ruby-2.2.2
8-
- jruby-9.0.0.0.pre2
6+
- ruby-2.0.0-p648
7+
- ruby-2.1.8
8+
- ruby-2.2.4
9+
- ruby-2.3.0-preview2
10+
- jruby-head
911
env:
1012
- JRUBY_OPTS="-Xcli.debug=true --debug"
1113
addons:
1214
code_climate:
13-
repo_token: bbd2a5e077e4b62bd8ba21a74a2ba901defc43506812f6192efc6b2a25c20d49
15+
repo_token: 60d9731d654527cb53aabc7db15bcde87d701ddb6b1cba8fc0da6aba16d00bb1
1416
before_install:
1517
- sudo add-apt-repository "deb http://cz.archive.ubuntu.com/ubuntu vivid main universe"
1618
- sudo apt-get update -q
1719
- sudo rm -rf /etc/dpkg/dpkg.cfg.d/multiarch
1820
- sudo apt-get install gnuplot5
21+
- gem update bundler
1922
- bundle install
2023
install:
2124
- bundle exec rake install

README.rdoc

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ This software has been developed as a product in Google Summer of Code 2015 (GSo
99
{<img src="https://gemnasium.com/dilcom/gnuplotrb.svg" alt="Dependency Status" />}[https://gemnasium.com/dilcom/gnuplotrb]
1010

1111
{<img src="https://travis-ci.org/SciRuby/gnuplotrb.svg" alt="Build Status" />}[https://travis-ci.org/SciRuby/gnuplotrb]
12-
{<img src="https://codeclimate.com/github/dilcom/gnuplotrb/badges/gpa.svg" alt="Code quality" />}[https://codeclimate.com/github/dilcom/gnuplotrb]
13-
{<img src="https://codeclimate.com/github/dilcom/gnuplotrb/badges/coverage.svg" alt="Test coverage" />}[https://codeclimate.com/github/dilcom/gnuplotrb]
12+
{<img src="https://codeclimate.com/github/sciruby/gnuplotrb/badges/gpa.svg" alt="Code quality" />}[https://codeclimate.com/github/sciruby/gnuplotrb]
13+
{<img src="https://codeclimate.com/github/sciruby/gnuplotrb/badges/coverage.svg" alt="Test coverage" />}[https://codeclimate.com/github/sciruby/gnuplotrb]
1414

1515
== Table of contents
16-
* {Installation}[https://github.com/dilcom/gnuplotrb#installation]
17-
* {Getting started}[https://github.com/dilcom/gnuplotrb#getting-started]
18-
* {Plottable classes}[https://github.com/dilcom/gnuplotrb#plottable-classes]
19-
* {Notebooks}[https://github.com/dilcom/gnuplotrb#notebooks]
20-
* {Plain examples}[https://github.com/dilcom/gnuplotrb#plain-examples]
21-
* {Contributing}[https://github.com/dilcom/gnuplotrb#contributing]
16+
* {Installation}[https://github.com/sciruby/gnuplotrb#installation]
17+
* {Getting started}[https://github.com/sciruby/gnuplotrb#getting-started]
18+
* {Plottable classes}[https://github.com/sciruby/gnuplotrb#plottable-classes]
19+
* {Notebooks}[https://github.com/sciruby/gnuplotrb#notebooks]
20+
* {Plain examples}[https://github.com/sciruby/gnuplotrb#plain-examples]
21+
* {Contributing}[https://github.com/sciruby/gnuplotrb#contributing]
2222

2323
== Installation
2424
=== Dependencies
@@ -34,7 +34,7 @@ This software has been developed as a product in Google Summer of Code 2015 (GSo
3434
* run
3535
bundle install
3636
==== Install latest version from source (may be unstable)
37-
git clone https://github.com/dilcom/gnuplotrb.git
37+
git clone https://github.com/sciruby/gnuplotrb.git
3838
cd gnuplotrb
3939
bundle install
4040
rake install
@@ -45,10 +45,10 @@ GnuplotRB gem is based on {Gnuplot}[http://www.gnuplot.info/] so I would recomme
4545

4646
=== Plottable classes
4747

48-
Each of plottable classes may be outputted to image file using ```#to_png```, ```#to_svg```, ```#to_gif``` and so on methods. You can read more about it in {GnuplotRB doc}[https://rubygems.org/gems/gnuplotrb] related to Plottable module or see examples in {beginners notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/basic_usage.ipynb].
48+
Each of plottable classes may be outputted to image file using ```#to_png```, ```#to_svg```, ```#to_gif``` and so on methods. You can read more about it in {GnuplotRB doc}[https://rubygems.org/gems/gnuplotrb] related to Plottable module or see examples in {beginners notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/basic_usage.ipynb].
4949

5050
==== Dataset
51-
Single dataset may be created with math formula ('sin(x)') or some data. If your data is stored in a file you can just pass a filename (e.g. 'gnuplotrb.data'). Dataset may also be constructed out of data contained in Ruby classes (Array, Daru containers), see {example notebooks}[https://github.com/dilcom/gnuplotrb#possible-datasources].
51+
Single dataset may be created with math formula ('sin(x)') or some data. If your data is stored in a file you can just pass a filename (e.g. 'gnuplotrb.data'). Dataset may also be constructed out of data contained in Ruby classes (Array, Daru containers), see {example notebooks}[https://github.com/sciruby/gnuplotrb#possible-datasources].
5252

5353
Dataset have several possible options which are explained in {gnuplot doc}[http://www.gnuplot.info/docs_5.0/gnuplot.pdf] (pp. 80-102). Options are passed to Dataset.new as hash and are tranlated into gnuplot format before plotting:
5454
Dataset.new(data, with: 'lines', using: '1:2')
@@ -74,9 +74,9 @@ Examples of option translation (nested containers allowed):
7474
# =>
7575
some_object.to_s
7676

77-
Once Dataset created, it may be updated with new data or options. Methods related to updating are explained in {a notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/updating_data.ipynb].
77+
Once Dataset created, it may be updated with new data or options. Methods related to updating are explained in {a notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/updating_data.ipynb].
7878

79-
Just as other Plottable object Dataset has several plotting methods which are desribed in {beginners notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/basic_usage.ipynb].
79+
Just as other Plottable object Dataset has several plotting methods which are desribed in {beginners notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/basic_usage.ipynb].
8080

8181
==== Plot
8282
Plot is a container for several datasets and layout options:
@@ -94,11 +94,11 @@ Almost the same as Plot but for 3-D plots. See Plot section.
9494
Container for several Plot or Splot objects, each of them is plotted in its own xy(z) space. So Multiplot offers single layout (image file\window) for several plots. It's grid is tuned by :layout option, and you can also set layout's title:
9595
Multiplot.new(plot1, plot2, splot1, layout: [3, 1], title: 'Three plots on a layout')
9696

97-
Updating methods for Multiplot are almost the same as Plot's and Dataset's and are covered in Multiplot's docs and {multiplot notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/multiplot_layout.ipynb]. See examples there.
97+
Updating methods for Multiplot are almost the same as Plot's and Dataset's and are covered in Multiplot's docs and {multiplot notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/multiplot_layout.ipynb]. See examples there.
9898

9999
==== Animation
100100

101-
Animation is a container for several Plot, Splot or Multiplot objects. Each of contained items is considered as frame in gif animation which is creating by ```#plot``` call. Animation's frames and options may be modifyed or updated just as other classes above. Animation does not support methods like ```#to_png``` and may be plotted only with ```#plot``` method. Please see {related notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/animated_plots.ipynb] and docs at RubyDoc for examples.
101+
Animation is a container for several Plot, Splot or Multiplot objects. Each of contained items is considered as frame in gif animation which is creating by ```#plot``` call. Animation's frames and options may be modifyed or updated just as other classes above. Animation does not support methods like ```#to_png``` and may be plotted only with ```#plot``` method. Please see {related notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/animated_plots.ipynb] and docs at RubyDoc for examples.
102102

103103
=== Notebooks
104104

@@ -109,54 +109,54 @@ To use GnuplotRB gem with iRuby you need to install them both.
109109

110110
* iRuby installation is covered in its {README}[https://github.com/SciRuby/iruby/blob/master/README.md].
111111
It also covers installation of iPython and other dependecies.
112-
* GnuplotRB gem installation covered in {README}[https://github.com/dilcom/gnuplotrb#installation] too.
112+
* GnuplotRB gem installation covered in {README}[https://github.com/sciruby/gnuplotrb#installation] too.
113113

114114
==== Embedding plots into iRuby
115115
Using GnuplotRB inside iRuby notebooks is covered in:
116116

117-
* {Basic usage notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/basic_usage.ipynb].
117+
* {Basic usage notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/basic_usage.ipynb].
118118

119119
==== 2D and 3D plots
120120
GnuplotRB is capable to plot vast range of plots from histograms to 3D heatmaps. Gem's repository contains examples of several plot types:
121121

122-
* {Heatmaps}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/heatmaps.ipynb]
123-
* {Vector field}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/vector_field.ipynb] (Thanks, {Alexej}[https://github.com/agisga])
124-
* {Math equations}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/math_plots.ipynb]
125-
* {3D visualizations}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/3d_plot.ipynb]
126-
* {Histogram}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/histogram.ipynb]
122+
* {Heatmaps}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/heatmaps.ipynb]
123+
* {Vector field}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/vector_field.ipynb] (Thanks, {Alexej}[https://github.com/agisga])
124+
* {Math equations}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/math_plots.ipynb]
125+
* {3D visualizations}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/3d_plot.ipynb]
126+
* {Histogram}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/histogram.ipynb]
127127

128128
==== Possible datasources
129129
GnuplotRB may take data in Ruby container or in a file. Supported containers for now are Arrays, Daru::Vector and Daru::DataFrame.
130130
When data given in file, GnuplotRB pass filename to Gnuplot *without* reading the file into memory.
131131

132132
Examples of using different datasources:
133133

134-
* {Data given in file or Ruby Array}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/points_from_different_sources.ipynb]
135-
* {Data given in Daru containers}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/plotting_from_daru.ipynb]
136-
* {Data given in Daru containers (with timeseries)}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/time_series_from_daru.ipynb]
137-
* {Updating plots with new data}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/updating_data.ipynb]
134+
* {Data given in file or Ruby Array}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/points_from_different_sources.ipynb]
135+
* {Data given in Daru containers}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/plotting_from_daru.ipynb]
136+
* {Data given in Daru containers (with timeseries)}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/time_series_from_daru.ipynb]
137+
* {Updating plots with new data}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/updating_data.ipynb]
138138

139139
==== Multiplot
140140
You can not only plot several datasets in single coordinate system but place several coordinate systems on a canvas.
141141

142-
* {Multiplot example notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/multiplot_layout.ipynb].
142+
* {Multiplot example notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/multiplot_layout.ipynb].
143143

144144
==== Animation
145145
It's possible to use several plots (Plot, Splot or Multiplot objects) to create gif animation.
146146

147-
* {Animation example notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/animated_plots.ipynb].
147+
* {Animation example notebook}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/animated_plots.ipynb].
148148

149149
==== Fitting data with formula
150150
GnuplotRB also may be used to fit some data with given math formula.
151151

152-
* {Fitting data}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/fitting_data.ipynb]
152+
* {Fitting data}[http://nbviewer.ipython.org/github/sciruby/gnuplotrb/blob/master/notebooks/fitting_data.ipynb]
153153

154154
=== Plain examples
155-
You may find several examples in {examples directory}[https://github.com/dilcom/gnuplotrb/tree/master/examples].
155+
You may find several examples in {examples directory}[https://github.com/sciruby/gnuplotrb/tree/master/examples].
156156

157157
== Contributing
158158

159-
1. {Fork repository}[https://github.com/dilcom/gnuplotrb/fork]
159+
1. {Fork repository}[https://github.com/sciruby/gnuplotrb/fork]
160160
2. Create your feature branch (`git checkout -b my-new-feature`)
161161
3. Commit your changes (`git commit -am 'Add some feature'`)
162162
4. Push to the branch (`git push origin my-new-feature`)

0 commit comments

Comments
 (0)