.. qats documentation master file, created by
   sphinx-quickstart on Sat Dec 16 19:53:09 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. Welcome to QATS's documentation!
.. ################################

QATS documentation
##################

General description
*******************

QATS is a python library and GUI for efficient inspection and analysis of time series. It simplifies and improves
post-processing, quality assurance and reporting of time-domain simulations.

Library
*******

The python library provides tools for:

* Import and export from/to various pre-defined time series file formats
* Signal processing
* Inferring statistical distributions
* Cycle counting using the Rainflow algorithm

It was originally created to handle time series files exported from `SIMO <https://www.dnvgl.com/services/complex-multibody-calculations-simo-2311/>`_
and `RIFLEX <https://www.dnvgl.com/services/riser-analysis-software-for-marine-riser-systems-riflex-2312>`_. Now it also
handles `SIMA <https://www.dnvgl.com/services/marine-operations-and-mooring-analysis-software-sima-2324>`_ hdf5 (.h5) files,
Matlab (version < 7.3) .mat files, CSV files and more. If you need handlers for other formats, create a feature
request (issue) or make it yourself and create a pull request.

See :ref:`examples` for more examples on how to invoke QATS in your own scripts to do more advance operations. :ref:`api`
provide information on the content of the QATS library.

.. See :ref:`changelog` for changelog.

GUI
***

QATS also features a :ref:`gui` which offers low threshold processing and vizualisation of time series. It is perfect for
inspecting, quality assurance and reporting. Use the library for more advanced operations.

.. image:: demo.gif
    :target: _images/demo.gif


Python version support
**********************

.. QATS currently supports Python version 3.8 and later. Note that version 3.12 is not properly tested but should work.

QATS currently supports Python version 3.8+. 

.. note::
    Python version <=3.11 is recommended, as version 3.12 is not yet formally tested.




Source code, Issue tracker and Changelog
****************************************

The `source code <https://github.com/dnvgl/qats>`_, `issue tracker <https://github.com/dnvgl/qats/issues>`_ and
`changelog <https://github.com/dnvgl/qats/releases>`_ are hosted on GitHub.


Downloads
*********

.. You can download and install QATS from `PyPI <https://pypi.org/project/qats/>`_. 
.. Or, see the :ref:`getting_started` for installation instructions.

QATS may be downloaded from `PyPI/qats <https://pypi.org/project/qats/>`_. 
See the :ref:`getting_started` section for installation instructions.

Table of contents
*****************
.. toctree::
   :maxdepth: 2

   getting_started
   examples
   gui
   api/index
   changes


.. Indices and tables
.. ******************
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`


..
.. Add project links in sidebar
..

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Project links

   PyPI Project <https://pypi.org/project/qats/>
   GitHub Repository <https://github.com/dnvgl/qats>
   Issue Tracker <https://github.com/dnvgl/qats/issues>
   Changelog <https://github.com/dnvgl/qats/releases>