Usage ===== .. _installation: Installation ------------ - Available as part of Mantid Workbench - From source code with Pixi - As a conda package: `Shiver `_ Application Information ----------------------- ``SHIVER`` is a desktop application for generating histograms from direct geometry inelastic data related to spectroscopy event reduction. It is built as a python package and can be used either as a standalone application or as a package imported in Mantid workbench. .. note:: `Github Shiver Repository `_ Technologies ------------ The project is written in Python (>=3.10). It is highly dependent on `Mantid `_. The Graphical User Interface (GUI) is based on `QtPy `_ (version is defined by Mantid) Project Structure ----------------- The main code of the project is at src/shiver, the documentation is at ``docs/`` and the tests are at ``tests/`` folders. The configurations for Pixi (pixi.lock, pyproject.toml) with pre-commit and readthedocs configurations are located in the root directory of the repostitory. The project contains additional scripts at ``DGS_SC_scripts/`` folder, which are the initial scripts that ``SHIVER`` was created around. The code follows the `MVP (Model-View-Presenter) `_ Thus, all current and future changes will follow this pattern.