=================
Welcome to DNPLab
=================
.. image:: https://img.shields.io/pypi/v/dnplab
   :target: https://pypi.org/project/dnplab/
   :alt: DNPLab

.. image:: https://img.shields.io/pypi/pyversions/dnplab
   :target: https://www.python.org/downloads/
   :alt: Python Version

.. image:: https://pepy.tech/badge/dnplab/month
   :target: https://pepy.tech/project/dnplab
   :alt: Downloads


Welcome to the DNPLab documentation. DNPLab is an object-oriented |OpenSource| Python-based package for importing, processing, and analyzing data determined in a Dynamic Nuclear Polarization (|DNPSpectroscopy|) experiment. The aim of the project is to provide a free, turn-key python-based processing package DNP-NMR data.

DNPLab is a collaborative project created by:

* |B12TLink|
* The |HanLabLink| at Northwestern University
* The |FranckLabLink| at Syracuse University

DNPLab is distributed free of charge under the |MITLicense|. 

Please report all issues on the |dnpLabGitIssueTrackerLink|.

Citing DNPLab
=============

If you are using DNPLab to process your DNP, NMR, or EPR data please add a link to this documentation (http://dnplab.net/) to your Materials and Methods section.

.. toctree::
   :caption: Overview
   :maxdepth: 1
   :hidden:

   introduction
   currentRelease


.. toctree::
   :caption: User Guide
   :maxdepth: 1
   :hidden:

   installation
   gettingStarted


.. toctree::
   :caption: Examples
   :maxdepth: 1
   :hidden:

   auto_examples/index


.. toctree::
   :caption: Reference
   :hidden:

   modules
   functions


.. toctree::
   :caption: About
   :hidden:

   people
   license
   getInvolved
   funding





.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`