.. _install:

For the users
=============

.. note::

  If you encounter an issue during installation, see our
  `troubleshooting section <instillation_troubleshooting>`_.
  If that doesn't resolve your issue, please create a bug report on our
  `Github issue tracker <https://github.com/mVenetos97/nmrcryspy/issues>`_.\


.. seealso::

  If you do not have Python or have an older version of Python, you may visit the
  `Python downloads <https://www.python.org/downloads/>`_ or
  `Anaconda <https://www.anaconda.com/products/individual/>`_ websites and follow their
  instructions on installing Python.

Installing nmrcryspy
--------------------

.. only:: html

  .. tabs::

    .. tab:: Local machine (Using pip)

      .. include:: pip.rst

    .. tab:: From source

      .. include:: source.rst

.. only:: not html

  Local machine (Using pip)
  '''''''''''''''''''''''''
  .. include:: pip.rst

  From source
  '''''''''''
  .. include:: source.rst


Updating nmrcryspy
------------------


If you are upgrading to a newer version of nmrcryspy, you should have all the prerequisites
already installed on your system. In this case, type the following in the terminal/Prompt

.. code-block:: bash

    $ pip install nmrcryspy -U


All done! You may now start using the library or proceed to
:ref:`getting_started` to continue the tutorial.