wiki:WikiStart

Version 52 (modified by flip, 9 years ago) (diff)

--

Welcome to the GAMMA/PyGAMMA Library

GAMMA - A General Approach To Magnetic Resonance Mathematical Analysis

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.

PyGAMMA makes GAMMA's APIs available to Python. It provides much of the functionality of GAMMA within the interactive and scriptable Python environment. PyGAMMA users can skip the compile and link steps necessary with C++, and can even run GAMMA commands interactively line-by-line.

Here we include a more detailed description of GAMMA.

Contributors to the GAMMA project

Obtaining and Building GAMMA (and PyGAMMA)

Obtaining and Building the GAMMA Library - Learn how to get a copy of the source code and what to do with it once you get it.

If you're interested in PyGAMMA, we provide prebuilt binaries for most platforms. We also have instructions on how to build PyGAMMA.

GAMMA/PyGAMMA Documentation

The original PDF Documentation, written by Scott Smith, is included in the gamma/doc directory (or gamma/trunk/doc). This includes a user manual, and a document for most of the GAMMA modules - roughly equivalent to the sub-directories of the gamma/src folder. While these PDF's have not been updated for recent code enhancements, they serve as a useful reference to what the library can do, and how to do it.

We also have examples written in C++ in the gamma/src/Tests folder, and Python examples (for PyGAMMA) in the gamma/src/pyTests directory.

For the very ambitious, we have archived the html that exists on the old GAMMA site (at ETHZ), and stored it in the gamma_docs subversion repository.

Developers Section: Technical Documentation, etc.

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 developers technical documentation.

Proper Citation in Papers and Presentations

Proper reference should be given, using the citation below, when GAMMA simulations are utilized 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.

For more information about NMR on the web

Funding

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

For a complete list of Wiki pages:

TitleIndex