Navigation Menu

Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
minad committed Jun 10, 2015
1 parent b8db6e2 commit c66d8a4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 12 deletions.
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -6,13 +6,14 @@ This guide covers way in which you can contribute.

There are various ways in which you can improve SciRuby. Coding and documentation are the two primary possibilities and participate in the [mailing list][mailing-list] -- suggesting ideas and changes is very important!

Apart from adding features and functionality, you can also create tests (we use RSpec), guides on how to do something using SciRuby, document the libraries and help find and fix bugs.
Apart from adding features and functionality, you can also create tests, guides on how to do something using SciRuby, document the libraries and help find and fix bugs.

Start by visiting our [issue tracker](https://github.com/SciRuby/sciruby/issues?state=open) if you want to start contributing, there's probably something with which you can help.
Start by visiting our [issue tracker](https://github.com/SciRuby/sciruby/issues?state=open) and the
[status list of the various gems](https://minad.github.io/sciruby-gems). If you want to start contributing, there's probably something with which you can help.

## Projects

SciRuby is an umbrella for many other projects in Ruby. There's not much hierarchy or anything, but we believe that the most important one at the time is [NMatrix][nmatrix], as it's very hard to create some scientific library that doesn't need a good numerical linear algebra library to deal with vectors and matrices.
SciRuby is an umbrella for many other projects in Ruby. The most important one at the time is [NMatrix][nmatrix], as it's very hard to create some scientific library that doesn't need a good numerical linear algebra library to deal with vectors and matrices.

So, the SciRuby subprojects are, in no particular order:

Expand All @@ -21,6 +22,7 @@ So, the SciRuby subprojects are, in no particular order:
- [Distribution][distribution]: Diverse statistical distributions. Uses C (statistics2/GSL) or Java extensions when available.
- [Integration][integration]: Integration methods.
- [Minimization][minimization]: Various minimization algorithms in pure Ruby.
- [IRuby][iruby]: Ruby kernel for the IPython/Jupyter notebook

## Documentation

Expand All @@ -43,4 +45,5 @@ Before commiting any code, you *MUST* read our [Contributor Agreement](http://gi
[distribution]: https://github.com/SciRuby/distribution
[integration]: https://github.com/SciRuby/integration
[minimization]: https://github.com/SciRuby/minimization
[iruby]: https://github.com/SciRuby/iruby
[rdoc]: http://rdoc.rubyforge.org/
24 changes: 15 additions & 9 deletions README.md
Expand Up @@ -4,32 +4,38 @@ Tools for Scientific Computing in Ruby

* [Website](http://sciruby.com)
* [NMatrix](http://github.com/SciRuby/nmatrix)
* [List of gems](https://minad.github.io/sciruby-gems)
* [List of scientific gems](https://minad.github.io/sciruby-gems)
* [Travis-CI](https://travis-ci.org/SciRuby/sciruby)

## Description

This gem acts as a meta gem which provides collects multiple scientific gems, including numeric and visualization libraries.
This gem acts as a meta gem which provides collects multiple [scientific gems](https://minad.github.io/sciruby-gems), including numeric and visualization libraries.

## Getting started

Installation:

gem install sciruby
gem install sciruby-full
~~~
gem install sciruby
gem install sciruby-full
~~~

If you want to have a full-blown installation, install `sciruby-full`.

Start a notebook server:

iruby notebook
~~~
iruby notebook
~~~

Enter commands:

require 'sciruby'
# Scientific gems are auto loaded, you can use them directly!
plot = Nyaplot::Plot.new
sc = plot.add(:scatter, [0,1,2,3,4], [-1,2,-3,4,-5])
~~~ ruby
require 'sciruby'
# Scientific gems are auto loaded, you can use them directly!
plot = Nyaplot::Plot.new
sc = plot.add(:scatter, [0,1,2,3,4], [-1,2,-3,4,-5])
~~~

Take a look at [gems.yml](gems.yml) or the [list of gems](https://minad.github.io/sciruby-gems) for interesting gems which are included in `sciruby-full`.

Expand Down

0 comments on commit c66d8a4

Please sign in to comment.