==================================
Welcome to pyILT2's documentation!
==================================

**pyILT2** is a **python library/API** to access the `NIST`_ *Standard Reference Database #147*,
aka Ionic Liquids Database - `ILThermo v2.0`_ .
It comes with `pyilt2report`_ , a simple **command line tool for search** requests.

.. note:: The author is not affiliated to the National Institute of Standards and Technology (NIST)!


.. toctree::
   :hidden:
   :maxdepth: 2

   Tutorial <usage>
   Package API <api>
   pyILT2report <pyilt2report>
   Phys. Properties <props>
   Changelog <changelog>
   License <license>


Installation
------------

You can install the latest version from the `Python package index`_.
From the command line, enter (in some cases you have to precede the command with :command:`sudo`):


.. code-block:: bash

	$ pip install pyilt2


More information about the usage and how to get and install ``pip`` you find in the `PIP documentation`_.

To install it manual, `download`_ the archive, unpack it, and type
(in some cases you have to precede the command with :command:`sudo`):


.. code-block:: bash

	$ python setup.py install


Requirements
------------

* Python 2 or 3
* `NumPy`_
* `Requests`_: HTTP for Humans


Cite
----

For the usage of the database ILThermo, *not* this software, please cite:

   1. Kazakov, A.; Magee, J.W.; Chirico, R.D.; Paulechka, E.; Diky, V.; Muzny, C.D.; Kroenlein, K.; Frenkel, M. "NIST Standard Reference Database 147: NIST Ionic Liquids Database - (ILThermo)", Version 2.0, National Institute of Standards and Technology, Gaithersburg MD, 20899, http://ilthermo.boulder.nist.gov.
   2.  Dong, Q.; Muzny, C.D.; Kazakov, A.; Diky, V.; Magee, J.W.; Widegren, J.A.; Chirico, R.D.; Marsh, K.N.; Frenkel, M., "ILThermo: A Free-Access Web Database for Thermodynamic Properties of Ionic Liquids." J. Chem. Eng. Data, 2007, 52(4), 1151-1159, doi: 10.1021/je700171f.


Final Note
----------

There is no official web API available to access ILThermo, which could have been used here.
Therefore the *stability* of this library depends on the *stability* of the JSON/javascript framework of the webservice.


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`

.. _ILThermo v2.0: http://ilthermo.boulder.nist.gov/
.. _Python package index: https://pypi.python.org/pypi
.. _download: https://pypi.python.org/pypi/pyilt2
.. _PIP documentation: https://pip.pypa.io/en/stable/#
.. _NumPy: http://www.numpy.org/
.. _Requests: http://docs.python-requests.org/en/master/
.. _pyilt2report: http://wgserve.de/pyilt2/pyilt2report.html
.. _NIST: https://www.nist.gov/