restoreio is a Python package to Restore Incomplete Oceanographic dataset, with specific focus on ocean surface velocity data. This package can also generate data ensemble and perform statistical analysis, which allows uncertainty qualification of such datasets.
pip install restoreio
conda install -c s-ameli restoreio
Successful installation and tests performed on the following operating systems and Python versions:
| Platform | Arch | Python Version | Continuous Integration | ||
|---|---|---|---|---|---|
| 3.9 | 3.10 | 3.11 | |||
| Linux | X86-64 | ✔ | ✔ | ✔ |  |
| AARCH-64 | ✔ | ✔ | ✔ | ||
| macOS | X86-64 | ✔ | ✔ | ✔ |  |
| ARM-64 | ✔ | ✔ | ✔ | ||
| Windows | X86-64 | ✔ | ✔ | ✔ |  |
| ARM-64 | ✔ | ✔ | ✔ | ||
See documentation, including:
An installation of restoreio offers two interfaces: a Python interface and a command-line 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.restorefunction. 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 forrestoreio.restorefunction. You can import this function byfrom restoreio import scan
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.restorefunction in the Python interface. - restore-scan: This executable is equivalent to
restoreio.scanfunction 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.
Alongside restoreio python package, we also offer an online service as a web-based interface for this software. This platform is available at: https://restoreio.org.
This online gateway allows users to efficiently process both local and remote datasets. The computational tasks are executed on the server side, leveraging the parallel processing capabilities of a high-performance computing cluster. Moreover, the web-based interface seamlessly integrates an interactive globe map, empowering sophisticated visualization of the results within the online platform.
We welcome contributions via GitHub's pull request. If you do not feel comfortable modifying the code, we also welcome feature requests and bug reports as GitHub issues.
If you publish work that uses restoreio, please consider citing the manuscripts available here.
This project uses a BSD 3-clause license, in hopes that it will be accessible to most projects. If you require a different license, please raise an issue and we will consider a dual license.