API Reference#

The main functions offered by restoreio are as follows. Note that these functions are accessible through both the Python Interface and Command-line interface.

Python Interface#

You can import the restoreio package using the command import traceflows. The key functions of this package include the following. For further information, refer to the Python Interface section.

restoreio.restore(input[, min_file_index, ...])

Restore incomplete oceanographic dataset and generate data ensemble.

restoreio.scan(input[, scan_velocity, ...])

Reads a netcdf file and returns data info.

Command Line Interface (CLI)#

The primary functions listed above are also accessible via the command-line interface. Further information can be found in the Command Line Intrerface section.