############
Introduction
############

RSKtools is the official MATLAB toolbox from RBR for reading, post-processing, visualising, and exporting data
stored in the RSK format produced by RBR loggers.

The RSK format that all `Logger2 and Logger3 instruments`_ (RBR *solo*, RBR *virtuoso*, RBR *duo*, RBR *concerto*, RBR *maestro*, etc.)
generate is not just another proprietary file format. Rather, it is a widely-used single file database called `SQLite`_ that
allows for very large files with high-speed access to any part of the dataset. As a result, you can read
RSKs from any programming language that supports SQLite. All you need to know is the schema of our table structure.

RSKtools uses a MATLAB structure (``RSK``) as its primary data container.
Upon opening an RSK file with :func:`RSKopen`, the structure is populated with metadata.
Data can then be loaded with :func:`RSKreaddata` or :func:`RSKreadprofiles`,
processed with functions such as :func:`RSKsmooth`, :func:`RSKalignchannel`, and :func:`RSKbinaverage`,
visualised with :func:`RSKplotdata` and :func:`RSKplotprofiles`, and
exported with :func:`RSK2CSV` or :func:`RSK2RSK`.

All optional input arguments use MATLAB's name-value pair convention, making the functions customisable and flexible.

To learn how to install RSKtools, please see the :doc:`installation </installation>` page. You may then wish to refer to our
:doc:`getting started </guides/getting-started-guide>` guide for usage information. A ``sample.rsk`` file is available for testing.

.. _Logger2 and Logger3 instruments: https://rbr-global.com/products/standard-loggers
.. _SQLite: https://sqlite.org/about.html
