Introduction

pyRSKtools is the official Python port of the MATLAB-based RSKtools toolbox. It provides the same functionality for users to access, process, visualize, and export data given in the RSK format from 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.

The organization of pyRSKtools revolves around a Python class referred to as the RSK class which, upon instantiation, will load deployment metadata of the given RSK, and may then later be used to load, process, visualize, or export data. The RSK class supports two data formats: a continuous time series, or a collection of profiles. After loading the data into the class, it is easy to plot and process the data using only the default input arguments. All optional input arguments are name-value pair arguments which make the class methods customizable and flexible.

To learn how to install pyRSKtools, please click installation. You may then wish to refer to our getting started guide and API overview for further usage information. A “sample.rsk” file is available for testing purpose.