.. pyXsurf documentation master file, created by
    sphinx-quickstart on Mon Mar 14 19:25:52 2022.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

.. |wip2| image:: resources/wip.png
    :height: 25px

Welcome to pyXsurf's documentation!
===================================

pyXSurf is a Python library to perform common operations on 2D or 1D data with coordinates.
It also includes a set of convenience functions and other tools for X-ray optics. 

.. .. image:: resources/wip.png   #this creates a large icon

Find how to get started in the :ref:`readme file <readme>`, and :ref:`how to contribute <readmedev>`.

Here some example (more coming soon!):

.. toctree::
    :maxdepth: 1

    tutorials
    Poster at SPIE San Diego 2023

🛠️ Ongoing Improvements!
Thanks for your interest to this project. We're currently making significant updates. Please check back soon to see the enhancements!

See also `Github page of the project <https://github.com/vincenzooo/pyXsurf>`_ 
for more examples in source subfolders. 


pyXsurf API
------------

.. toctree::
    api 

Indices and Tables
-------------------

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