Documentation
Word to the wise: These gems have been tested, but not extensively. If you’re thinking of using SciRuby to write mission critical code, such as for driving a car or flying a space shuttle, you may wish to choose other software (for now).
You might also check out the NMatrix wiki if you have trouble finding answers here.
General instructions
These instructions are primarily for NMatrix installation. Until a new version of SciRuby is released, you’ll need to install component gems manually (see below).
Make sure you have Ruby 1.9.2 or higher. Individual components may work with Ruby 1.8, but we may not be able to help you if you have trouble.
For NMatrix, you’ll also need a compiler which supports C++0x or C++11, such as GCC 4.3 or higher. Mac OSX GCC instructions are here.
Install ATLAS (required for NMatrix). If you’re using a Mac, this should be part of Developer Tools.
Install NMatrix:
gem install nmatrix
That step should take about twenty minutes and won’t offer much feedback.
If that doesn’t work, you might also try compiling the sources manually:
git clone https://github.com/SciRuby/nmatrix.git
cd nmatrix/
bundle install
rake compile
rake repackage
gem install pkg/nmatrix-*.gem
Note that the above will give you the development version, which probably hasn’t been released yet.
Platform notes
Alpha workaround instructions
If you have any trouble getting SciRuby to work and are too impatient to seek assistance, most of the SciRuby components are already available as individual packages. We recommend you try out the following component gems:
- Visualization: rubyvis
- Statistics: statsample
- Numeric: minimization, integration, nmatrix
- Probability: distribution
SciRuby
Don’t do this. SciRuby depends on statsample, which requires NArray, which conflicts with NMatrix.
But if you absolutely must, you can install the SciRuby gem as follows:
gem install gtksourceview2 # optional, for code editor
gem install statsample-optimization # optional: rb-gsl, statistics2 -- for the statsample gem
gem install sciruby
We expect it to be fixed once Ruby/GSL includes NMatrix support.
Project Status
As we are currently alpha, documentation is a work in progress. If you want to get involved, please drop by our Google Group or our IRC channel, #sciruby.
In the meantime, documentation for existing gems is scattered. You can look through the links below for additional information.
Project Pages
rdocs
- Rubyvis
- Distribution (part of Statsample)
- Statsample
Other resources
For SciRuby project documentation, you should visit the SciRuby wiki.
You should subscribe to our blog if you want updates, too.