.. ParticleSpy documentation master file, created by
   sphinx-quickstart on Mon Nov 26 12:04:51 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ParticleSpy's documentation!
=======================================

ParticleSpy is a python package which eases segmentation and analysis of nanoparticles from electron microscopy data. 
It extends the functionality of the `Hyperspy <http://hyperspy.org/>`_ package in order to easily segment and analyse regions of Hyperspy signal objects.

.. toctree::
   :maxdepth: -1
   :caption: Contents:
   
   getting_started.rst
   segmentation.rst
   particle_analysis.rst
   plotting_saving.rst
   time_series.rst


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

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