.. _installing:

Getting started
===============

.. contents:: Table of contents:
   :local:

Compatibility
-------------

``qha`` is compatible with Python 3.6.x.

Our supported platforms are:

* Linux x86 (32-bit and 64-bit)
* Windows 7 and later (32-bit and 64-bit)
* OS X 10.9 and later (64-bit)
* NVIDIA GPUs of compute capability 2.0 and later

Dependencies
------------
- `mpmath <http://mpmath.org/>`_
- `lazy-property <https://github.com/jackmaney/lazy-property>`_
- `matplotlib <https://matplotlib.org>`_ [#m]_
- `Numba <http://numba.pydata.org>`_
- `NumPy <http://www.numpy.org>`_
- `pandas <https://pandas.pydata.org>`_
- `PyYAML <http://pyyaml.org>`_
- `scientific-string <https://github.com/singularitti/scientific-string>`_
- `SciPy <https://www.scipy.org>`_
- `text-stream <https://github.com/singularitti/text-stream>`_

Notes:

.. [#m] For some systems, ``python-tkinter`` package is needed by ``matplotlib``, otherwise the plot function will not work.

Installing the ``qha`` package
------------------------------
Installing using PyPI
~~~~~~~~~~~~~~~~~~~~~~

``qha`` can be installed via pip from
`PyPI <http://pypi.python.org/pypi/qha>`__.::

   $ pip install qha

This will likely require the installation of a number of dependencies,
including NumPy, will require a compiler to compile required bits of code,
and can take a few minutes to complete.

Installing from source
~~~~~~~~~~~~~~~~~~~~~~
Download the `latest release <https://github.com/MineralsCloud/qha/releases>`_ , and go to the top-level directory, run::

   $ pip install -e .

Checking your installation
--------------------------

You should be able to import Numba from the Python prompt::

   $ python
   Python 3.6.5 (default, Jun 18 2018, 22:40:57)
   [GCC 4.2.1 Compatible Apple LLVM 9.1.0 (clang-902.0.39.2)] on darwin
   Type "help", "copyright", "credits" or "license" for more information.
   >>> import qha
   >>> qha.__version__
   '1.0.12'