nmrespy 1.0

NMR-EsPy: Nuclear Magnetic Resonance Estimation in Python

.. image:: https://raw.githubusercontent.com/foroozandehgroup/NMR-EsPy/master/nmrespy/images/nmrespy_full.png
:align: center
:width: 300

.. class:: center

**Simon Hulse and Mohammadali Foroozandeh, University of Oxford**

.. class:: center

.. image:: https://badge.fury.io/py/nmrespy.svg
:target: https://badge.fury.io/py/nmrespy

.. image:: https://github.com/foroozandehgroup/NMR-EsPy/workflows/publish-docs/badge.svg
:target: https://github.com/foroozandehgroup/NMR-EsPy/actions?query=workflow%3Apublish-docs

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT


NMR-EsPy: **N**\uclear **M**\agnetic **R**\esonance **Es**\timation in **Py**\thon
is a Python package developed for estimating the parameters that describe
NMR data.

Getting started:

* Installation: ``python -m pip install nmrespy``
* HTML Documentation: https://foroozandehgroup.github.io/NMR-EsPy/
* Check out the `Example Walkthrough <https://https://foroozandehgroup.github.io/NMR-EsPy/walkthrough.html>`_
page in the docs for a tutorial on NMR-EsPy's basic usage.
* This `2022 JMR paper <https://doi.org/10.1016/j.jmr.2022.107173>`_ provides a detailed description of the theory behind NMR-EsPy
and showcases a couple of results derived using it.

.. image:: https://raw.githubusercontent.com/foroozandehgroup/NMR-EsPy/master/docs/content/media/walkthrough/5_54-5_42.png
:scale: 5 %
:align: center