.. Purpose: The root document of the project, which serves as welcome page and contains the root
.. of the "table of contents tree" (or toctree).

Welcome to SHIVER's documentation!
==================================
The Spectroscopy HIstogram Visualizer for Event Reduction **(SHIVER)** is a tool to
allow examination of time of flight inelastic neutron data, from single crystal,
direct geometry experiments. It is intended to perform the following tasks:

* Transform time of flight data from multiple orientations into a single intermediate
  structure in units of reciprocal space and energy transfer.


* Allow slicing of the intermediate file and creation of histograms containing S(**Q**, ∆ *E*)
  with various dimensionality


* Visualize the histograms

Check out the :doc:`usage` section for further information, including :ref:`installation`
steps for this project.

.. note::

   This project is under active development.

Contents
--------

.. toctree::
   :maxdepth: 1

   getting_started
   usage
   repo_doc