.. PRTP documentation master file, created by
   sphinx-quickstart on Thu May 30 08:28:01 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PRTP's documentation!
================================

The Python Raytrace Package (PRTP) is a package of Python functions that simulate X-Ray instruments. It was designed for the McEntaffer Group at the Pennsylvania State University. PRTP expands on the functionality of `PyXFocus <https://github.com/rallured/PyXFocus>`_, but with a more intuitive, modular design.

.. toctree::
   :maxdepth: 3
   :caption: Contents:

   Overview
   Components
   flatcomp
   collimatorplate
   detector
   grating
   gratingstack
   wolteroptics
   sources
   combination
   modification
   instrument
   rays
   astropyunits


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

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