########################################
Welcome to the nmrcryspy documentation
########################################

.. .. image:: _static/null.png
..     :align: center

.. only:: html

    .. cssclass:: table-bordered table-striped centered

    .. list-table::
      :widths: 25 75
      :header-rows: 0

      * - License
        - .. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
            :target: https://opensource.org/licenses/BSD-3-Clause
            :alt: License


      * - Social
        - .. image:: https://img.shields.io/github/contributors/mVenetos97/nmrcryspy?style=social&logo=github
            :target: https://github.com/mVenetos97/nmrcryspy/graphs/contributors
            :alt: GitHub contributors

          .. image:: https://img.shields.io/github/issues/mVenetos97/nmrcryspy?style=social&logo=github
            :target: https://github.com/mVenetos97/nmrcryspy/issues
            :alt: GitHub issues

          .. image:: https://img.shields.io/github/stars/mVenetos97/nmrcryspy?style=social
            :target: https://github.com/mVenetos97/nmrcryspy/stargazers
            :alt: GitHub stars


.. only:: html

  **About**

.. only:: not html

  About
  '''''

**nmrcryspy** is an open-source Python package for NMR crystallography. The primary goal of this
library is to speed up crystallographic refinement procedures.


----

Introduction
------------

.. toctree::
    :maxdepth: 2
    :caption: Introduction

    installation/installation
    refinements/refinements

User Guide
----------

.. toctree::
    :maxdepth: 3
    :caption: User Documentation

    getting_started/getting_started


Examples
--------

.. toctree::
    :maxdepth: 2
    :caption: Galleries


API and references
------------------

.. toctree::
   :maxdepth: 2
   :caption: API and references

   api_py/py-minimizer
   api_py/fit-functions
   api_py/linesearch.rst
   api_py/utils