.. GraSPI documentation master file, created by
   sphinx-quickstart on Tue Dec 15 13:51:07 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to GraSPI's documentation!
==================================

|graspi| is graph-based structure property identifier software implemented as a C/C++ package.
|graspi| computes a library of descriptors for a segmented microstructure
and computes descriptors that are relevant for organic solar cells performance.
The package represents microstructure as a graph and harnesses the graph-based
theory to compute wide range of descriptors at low computational cost.
A suite of tools for data conversion between various formats and for
post-processing the raw results from the graph analysis is provided.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   graspiFunctionality
   inputFormats
   exampleOfUsage
   listOfDescriptors
   graphBasedRepresentation
   basicDefinitions
   basicOperationsOnGraphs
   build
   credit


.. toctree::
         :maxdepth: 2

         api/library_root


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

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