Install with pip

pip install restoreio

Install with conda

conda install -c s-ameli restoreio

1. Python Interface

You can import restoreio in python by import restoreio. This package offers the following functions:

• restoreio.restore: This is the main function of the package which reconstructs incomplete velocity data, generates data ensemble, and performs statistical analysis. You can import this function by

  from restoreio import restore

• restoreio.scan: This function performs a pre-scan of your NetCDF dataset and ensures your dataset is compatible as an input to restoreio.restore function. The scan also provides you basic information about the dataset such as the time span, spatial extent of the data. These information could be useful to configure the settings for restoreio.restore function. You can import this function by

  from restoreio import scan

2. Command-Line Interface

Alternatively, you may use restoreio as a standalone application which can be executed in command line. When restoreio is installed, the following executables are available:

• restore: This executable is equivalent to restoreio.restore function in the Python interface.

• restore-scan: This executable is equivalent to restoreio.scan function in the Python interface.

To use these executables, make sure the /bin directory of your Python installation is set on your PATH environment variable. For instance, if your Python is installed on /opt/minicinda3/, add this path /opt/miniconda3/bin directory to PATH by

export PATH=/opt/minicinda/bin:$PATH

You may place the above line in ~/.bashrc to make the above change permanently.