A python toolbox for simulating NMR spectra
Project description
[![Build Status](https://travis-ci.org/DeepanshS/mrsimulator.svg?branch=master)](https://travis-ci.org/DeepanshS/mrsimulator) [![Documentation Status](https://readthedocs.org/projects/mrsimulator/badge/?version=stable)](https://mrsimulator.readthedocs.io/en/stable/?badge=stable)
# mrsimulator
mrsimulator is a library package with methods and tools for fast simulation of solid-state nuclear magnetic resonance (NMR) line-shapes. The library contains routines written in C which are wrapped and made available in python.
The package is currently under development. At present, mrsimulator features simulation of one-dimensional NMR line-shape of uncoupled spin I=1/2 isotopes for the following scenarios –
At arbitrary macroscopic magnetic flux density,
Magic angle spinning (MAS) at arbitrary spin rate,
Variable angle spinning (VAS) at arbitrary angle and spin rates,
Static line-shape.
For more information, refer to the [documentation](https://deepanshs.github.io/mrsimulator/).
## Installation
We recommend installing [anaconda](https://www.anaconda.com/distribution/) distribution for python version 3.6 or higher. The anaconda distribution ships with numerous packages and modules including Numpy, Scipy, and Matplotlib which are useful packages for scientific datasets.
### Download mrsimulator package
First, clone and download the mrsimulator package from Github. If you prefer git, type the following in the terminal,
$ git clone git://github.com/DeepanshS/mrsimulator.git
else, [download](https://github.com/DeepanshS/mrsimulator) the package using the browser. Once downloaded, use the terminal to navigate to the directory containing the package (usually, the folder is named mrsimulator).
$ cd mrsimulator
### Installing dependencies
Next, install the dependencies of the package. We recommend using conda to install the dependencies, as follows,
$ conda install -c conda-forge openblas –file requirements.txt
### Building and Installing mrsimulator package
Because the core of the mrsimulator package is written in C, you will require a C-compiler to build and install the package. We recommend the following C-compiler for the OS types:
Mac OS - clang
Linux - gcc
Windows - msvc
Install the package with,
$ python setup.py install
## Check your build
If the installation is successful, you should be able to run the following [test file](https://raw.github.com/DeepanshS/mrsimulator-test/master/test_file.py?raw=true) in your terminal.
$ python test_file.py
This should produce the following figure.
![alt text](https://raw.githubusercontent.com/DeepanshS/mrsimulator/master/docs/_static/test_output.png)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for mrsimulator-0.1.2-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f3db293685372ff7390877b594cdea4acc43ccd8cd6d6bbabf13f2b835a2bc2 |
|
MD5 | 3f929db8f2f305eb885d6e71ac40abbf |
|
BLAKE2b-256 | 3d7187788c2fa714eb18fee4d97d20c53896c2f09e382e6f82a1a8f3e088efe1 |
Hashes for mrsimulator-0.1.2-cp37-cp37m-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81c9501b176c182db9c2bdf369900ded339c80243a8a6bb3a9ef52d3910b8ab4 |
|
MD5 | 3fcd71347dd5af6ebb8d4f230b9f6875 |
|
BLAKE2b-256 | 28dea330ed1f27e98e685da0434848c3688ced0401adb3ded320d1ee64ad5dd1 |
Hashes for mrsimulator-0.1.2-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 963fe29bf68be47763a6c9af270222ec35523f0a46f2387f70472c0954f85d0f |
|
MD5 | 5f935d7028f99718c733d0e730a523f0 |
|
BLAKE2b-256 | 3e96f694a7465d2a194af7b1c9df5eb93ae1caf1568605d2feee441f052a4cf9 |