.. RSS documentation master file, created by
   sphinx-quickstart on Sat Sep  3 14:06:50 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to NRSS's documentation!
=================================
The NIST RSoXS Simulation Suite (NRSS) is a collection of Python and C++/CUDA tools for creating, simulating, and analyzing Resonant Soft X-ray Scattering (RSoXS). It leverages the `CyRSoXS <https://github.com/usnistgov/cyrsoxs>`_ C++/CUDA library for GPU-accelerated simulations, and the `PyHyperScattering <https://github.com/usnistgov/PyHyperScattering>`_ library for reducing and analyzing the simulated scattering patterns. For more information on what RSoXS is and how you can possibly apply it in your own research, check out the NIST RSoXS project page at https://www.nist.gov/programs-projects/resonant-soft-x-ray-scattering-rsoxs.

.. toctree::
   :maxdepth: 4
   :caption: Contents:

   gettingstarted
   cyrsoxs
   pyhyper
   tutorials
   api/api



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

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