=====================================
iechelle: Interactive Echelle Diagram
=====================================

.. image:: https://gitlab.com/dinilbose/iechelle/-/raw/main/docs/source/_static/logo_readme.png
   :align: right
   :alt: iechelle logo

**iechelle** is a powerful and interactive graphical user interface designed specifically for helping peakbagging.


Full documentation is available at: `https://dinilbose.gitlab.io/iechelle <https://dinilbose.gitlab.io/iechelle>`_

.. image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
   :target: https://gitlab.com/dinilbose/iechelle/-/network/main
.. image:: https://img.shields.io/badge/Apache V2.0-green

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

You can install **iechelle** using one of the following methods:

Via PyPI
--------

The easiest way to install the latest stable version is via ``pip``:

.. code-block:: bash

    pip install iechelle



From Sources
------------

Clone the repository and install using **Poetry**:

.. code-block:: bash

    git clone https://github.com/dinilbose/iechelle.git
    cd iechelle
    poetry install

Alternatively, use ``pip``:

.. code-block:: bash

    pip install .

Development Setup
-----------------

If you want to contribute to the project, use the provided ``Makefile`` to set up a full development environment:

.. code-block:: bash

    # 1. Prepare the environment and hooks
    make prepare-dev
    source .iechelle

    # 2. Install all dependencies including dev tools
    make install-dev

Running the Application
-----------------------

After installation, you can start the interactive GUI simply by typing:

.. code-block:: bash

    iechelle

Or via the provided ``Makefile``:

.. code-block:: bash

    make run

Alternatively, you can start it manually via Bokeh:

.. code-block:: bash

    bokeh serve iechelle/gui --show

.. warning::
   **CRITICAL:** PSD files Frequency input should be in HZ.


Author
------
👤 **Dinil Bose Palakkatharappil**



🤝 Contributing
---------------
Contributions, issues and feature requests are welcome!
Feel free to check the `issues page <https://gitlab.com/dinilbose/iechelle/issues>`_. You can also take a look at the `contributing guide <https://gitlab.com/dinilbose/iechelle/blob/main/CONTRIBUTING.rst>`_.


📝 License
----------
This project is `Apache V2.0 <https://gitlab.com/dinilbose/iechelle/blob/main/LICENSE>`_ licensed.
