.. VcatPy documentation master file, created by
   sphinx-quickstart on Fri Mar  9 22:59:43 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Photon Documentation
====================

|python| |Python36| |zenodo| |Licence|
|matplotlib| |PyQt5| |numpy| |scipy| 

.. |Licence| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
      :target: http://perso.crans.org/besson/LICENSE.html

.. |Opensource| image:: https://badges.frapsoft.com/os/v1/open-source.svg?v=103
      :target: https://github.com/ellerbrock/open-source-badges/

.. |zenodo| image:: https://zenodo.org/badge/132375021.svg
   :target: https://zenodo.org/badge/latestdoi/132375021

.. |python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
    :target: https://www.python.org/downloads/release/python-360/

.. |PyQt5| image:: https://img.shields.io/badge/poweredby-PyQt5-orange.svg
   :target: https://pypi.python.org/pypi/PyQt5

.. |matplotlib| image:: https://img.shields.io/badge/poweredby-matplotlib-orange.svg
   :target: https://matplotlib.org/

.. |Python36| image:: https://img.shields.io/badge/python-3.6-blue.svg
.. _Python36: https://www.python.org/downloads/release/python-360/

.. |numpy| image:: https://img.shields.io/badge/poweredby-numpy-orange.svg
   :target: http://www.numpy.org/

.. |scipy| image:: https://img.shields.io/badge/poweredby-scipy-orange.svg
   :target: https://www.scipy.org/

.. figure:: ./example/fulllogo.png
    :width: 750px
    :align: center
    :alt: GUI


Contents
========
.. toctree::
   :maxdepth: 1

   Home <self>
   usage
   graphics
   custom
   gallery
   log

----

Photon is a GUI created to make simple 1D plot in python. It uses mainly matplotlib and PyQt5 and it has been build in the spirit of being fully customizable. You can change fontstyle, fontsize, fontcolors, linewidth of the axes, thickness, etc...and see the changes directly in the plot. Once a customization is created, you can save it into a configuration file and reload it later when you open photon again. This allows you to keep the same customization for different plot. The main tool is a graphical user interface and it is started using a command line interface.


----

**Contribute!**

If you have any comment or anything you would like to be added to photon, or, even better, if you want to modify you can either do it yourself or  please feel free to contact me! ---> @ **the.spartan.proj@gmail.com**

----

.. warning::
 
	**Copyright**
 
	Photon is a free software: you can redistribute it and/or modify it under 
	the terms of the GNU General Public License as published by the Free Software Foundation, 
	version 3 of the License.
 
	Photon is distributed without any warranty; without even the implied warranty of merchantability 
	or fitness for a particular purpose.  See the GNU General Public License for more details.
 
	You should have received a copy of the GNU General Public License along with the program.
	If not, see http://www.gnu.org/licenses/ .