GIWAXS toolbox
===================

This package is a collection of python based tools to help with visualising and analysing Grazing Incidence Wide Angle X-ray Scattering (GIWAXS) data collected at Diamond Light Source on beamline I07. 

The initial processing and mapping step is handled by the `fast_rsm`_ package, and this toolbox is designed to work with the output from that package. The toolbox includes a collection of interactive widgets to help explore and visualise GIWAXS datasets, as well as tools for extracting datasets for further analysis including fitting peaks in 1D datasets.



Accessing the giwaxs_toolbox
-------------------------------

Option 1:
****************

    `diamond_guide`_ : Guide on accessing the giwaxs_toolbox on the Diamond filesystem 

Option 2:
****************
   `local_install`_ : If you are familiar with setting up and using python environments you can use the following instructions for installing a local version of giwaxs_toolbox



Guides on using the giwaxs_toolbox
-----------------------------------------

   `walkthrough guides`_ : Walkthroughs with examples on using the various options available within the giwaxs_toolbox


Training videos
-------------------------

   `training videos`_ : A collection of training videos on how to use the various features of the giwaxs_toolbox, and how to create datasets to use with the toolbox.




Contributing
------------
As with any coding project, there are many ways to contribue. To report a bug or suggest a feature, `open an issue on the github repository`_. If you would like to contribute code, we would recommend that you first `raise an issue`_ before diving into writing code, so we can let you know if we are working on something similar already. To e.g. fix typos in documentation or in the code, or for other minor changes, feel free to make pull requests directly.


Contact us
----------------
If you need to contact the developers about anything, please either `raise an issue on the github repository`_ if appropriate, or send an email to philip.mousley@diamond.ac.uk.


.. toctree::
   :hidden:
   :maxdepth: 2

   diamond_guide
   local_install
   useage_guide
   training_videos


.. _diamond_guide: ./diamond_guide.html
.. _local_install: ./local_install.html
.. _walkthrough guides: ./useage_guide.html
.. _training videos: ./training_videos.html
.. _fast_rsm: https://fast-rsm.readthedocs.io/en/latest/index.html
.. _open an issue on the github repository: https://github.com/DiamondLightSource/giwaxs_toolbox/issues
.. _raise an issue: https://github.com/DiamondLightSource/giwaxs_toolbox/issues
.. _raise an issue on the github repository: https://github.com/DiamondLightSource/giwaxs_toolbox/issues