Install

rdoc
Rubyforge Project Page

Prerequisites

Much of the package will work without any prerequisites at all. Some functionality may require addition ruby packages or other converters.

• libjtp - generic library installed automatically if you install mspire with rubygems (or 'gem install libjtp')

XML parsing:

• xmlparser (comes with one-click Windows; on Ubuntu: 'sudo apt-get libxml-parser-ruby1.8')
• axml dom wrapper for xmlparser. ('gem install axml')

Optional:

• 't2x' linux executable to convert .RAW files (Xcalibur 1.x) to version 1 mzXML files
• libxml can use instead of xmlparser. In Ubuntu: sudo apt-get install libxml2 libxml2-dev ; sudo gem install libxml-ruby --remote
• gnuplot ('gem install gnuplot'). For some plotting. Of course, you'll need gnuplot before this package will work. Under one-click installer for windows this package requires a little configuration. It works with no configuration on cygwin (or linux).

Installation

# stable full featured:
gem install mspire -v 0.4.7 

# development version 0.5.0:
gem install mspire

See installation under cygwin if you're on Windows.

Development

NOTE: If you are interested in becoming a developer on this project (i.e., write access to the repository) please contact me.

The repository is on github:

git clone git://github.com/jtprince/mspire.git

large test files are here:

svn checkout svn://rubyforge.org/var/svn/mspire

prerequisites:

• rake (with rubygems: 'gem install rake --remote')
• rspec (with rubygems: 'gem install rspec --remote')

Use rake:

% rake -T
rake clean              # Remove any temporary products.
rake html_docs          # creates docs in doc/html
rake package            # Build all the packages
rake test               # Run tests
rake test_ind           # Run unit tests individual on each test
rake upload_docs        # create and upload docs to server
...etc...

run tests: rake spec
     (or): rake specl

run tests with large files: rake spec SPEC_LARGE=t

run test on one file: rake spec SPEC=specs/{path_to_spec_file}