Spectral Clustering for Molecular Emission Segmentation
=======================================================

.. image:: figures/scimes_logo.png
   :width: 200px
   :align: center

``SCIMES`` identifies relevant molecular gas structures within
dendrograms of emission using the spectral clustering paradigm.
``SCIMES`` is useful to decompose objects in complex
enviroments imaged at high resolution.  

Documentation
-------------

.. toctree::
   :maxdepth: 2

   installation.rst
   algorithm.rst
   tutorial.rst
   

Reporting issues and getting help
---------------------------------

Please help us improve this package by reporting issues via `GitHub
<https://github.com/Astroua/SCIMES/issues>`_. You can also open an
issue if you need help with using the package.

Developers
----------

This package is developed by:

* Dario Colombo
* Erik Rosolowsky
* Adam Ginsburg
* Ana Duarte-Cabral
* Annie Hughes

Acknowledgements
----------------

Thanks for the help with the documentation to:

* Eric Koch


Citing SCIMES
-------------

If you make use of this package in a publication, please add the following
acknowledgment:

*This research made use of SCIMES, a Python package to find relevant structures
into dendrograms of molecular gas emission using the spectral clustering
approach* and cite the `related paper, 2015MNRAS.454.2067C
<http://esoads.eso.org/abs/2015MNRAS.454.2067C>`__

``SCIMES`` is an astropy affiliated-package. Please also consider adding 
an acknowledgment for Astropy (see
`<http://www.astropy.org>`_ for the latest recommended citation).

Public API
----------

.. automodapi:: scimes

   :no-inheritance-diagram: