============
Installation
============

Source Code
===========

All the code is in ``debyetools`` repository on GitHub_.

Requirements
============

* Python_ 3.6 or newer
* NumPy_ (base N-dimensional array package)
* SciPy_ (fundamental algorithms for scientific computing in Python)
* mpmath_ (real and complex floating-point arithmetic with arbitrary precision)

Other recommended packages:

* Matplotlib_ (for plotting,  a comprehensive library for visualizations in Python)
* PySide6_ (for the GUI, PySide6 is the official Python module from the Qt for Python project)

Installation using pip
======================

The simplest way to install ``debyetools`` is to use pip_ which will automatically get the source code from PyPI_::

    $ pip install --upgrade debyetools

.. _Python: https://www.python.org/
.. _NumPy: https://docs.scipy.org/doc/numpy/reference/
.. _PyPI: https://pypi.org/project/debyetools/
.. _SciPy: https://scipy.org
.. _PIP: https://pip.pypa.io/en/stable/
.. _Matplotlib: https://matplotlib.org/
.. _PySide6: https://pypi.org/project/PySide6/
.. _GitHub: https://github.com/jjofres/debyetools
.. _mpmath: https://mpmath.org/