=======
Install
=======

Install ionique
===============

The most recent release of the  ``ionique`` package can be installed using pip_

.. code-block:: console

   $ pip install ionique

For interactive dashboards and plotting widgets (Panel, Bokeh), install with
the ``panel`` extra:

.. code-block:: console

   $ pip install ionique[panel]

If you are very new to coding, more detailed instructions, we provide guides on VSCode, Python3 and ionique installment.


Installation from Source
========================

If you want to contribute to ionique you can build ionique from source using the
instructions below.

.. code-block:: console

   $ git clone https://github.com/wanunulab/ionique.git
   $ cd ionique
   $ pip install -e .

To include the interactive dashboard extras in a development install:

.. code-block:: console

   $ pip install -e ".[panel]"