wiki:WikiStart
Last modified 22 months ago Last modified on 12/31/12 09:52:21

Welcome to the GAMMA/PyGAMMA Library

GAMMA is a C++ library for the simulation of magnetic resonance (NMR, MRS) experiments. It provides a simple and intuitive means to construct simulation programs to suit researchers' individual needs. GAMMA is an acronym for a General Approach to Magnetic resonance Mathematical Analysis.

PyGAMMA is a Python wrapper around GAMMA that makes almost all of GAMMA's API available via Python. PyGAMMA users can skip the C++ compile and link steps and can even run GAMMA commands interactively line-by-line.

Both GAMMA and PyGAMMA work on OS X, Linux, and Windows.

For more information, refer to our detailed description of GAMMA and our main PyGAMMA page.

Downloading GAMMA and PyGAMMA

One can download prebuilt PyGAMMA libraries for many platforms.

We don't supply prebuilt GAMMA libraries, but we have instructions on how to download and build GAMMA.

Documentation

The original documentation written by Scott Smith in the gamma/doc/pdf directory of the GAMMA source code distribution.

The PDFs include a user manual, and one document each for most GAMMA modules. These documents are somewhat dated. Nevertheless, they serve as a useful reference to what the library can do, and how to do it.

We also supply C++ examples in in the gamma/src/Tests folder, and Python examples in gamma/src/pyTests.

For the very ambitious, we have archived the HTML from the old GAMMA Web site.

Developer (Technical) Documentation

If you're interested in more technical details about GAMMA/PyGAMMA including notes from the developers themselves, or suggestions on how to contribute to GAMMA/PyGAMMA, we have a whole section dedicated to developer documentation.

Proper Citation in Papers and Presentations

Proper reference should be given, using the citation below, when GAMMA simulations are used in papers and/or presentations.

"Computer Simulations in Magnetic Resonance. An Object Oriented Programming Approach", S.A. Smith, T.O. Levante, B.H. Meier, and R.R. Ernst, J. Magn. Reson., 106a.

Thanks

Thanks to the NIH (grant number 1R01EB008387-01A1) which funded the recent work on GAMMA, PyGAMMA and this website via the Vespa project.

Thanks also to those who have contributed their time and skills to GAMMA/PyGAMMA.