restoreio

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.

Install

Install with pip

pip install restoreio

Install with conda

conda install -c s-ameli restoreio

Supported Platforms

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	✔	✔	✔
Linux	AARCH-64	✔	✔	✔
macOS	X86-64	✔	✔	✔
macOS	ARM-64	✔	✔	✔
Windows	X86-64	✔	✔	✔
Windows	ARM-64	✔	✔	✔

Documentation

See documentation, including:

Usage

An installation of restoreio offers two interfaces: a Python interface and a command-line interface.

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.

Online Web-Based Interface

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.

How to Contribute

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.

How to Cite

If you publish work that uses restoreio, please consider citing the manuscripts available here.

License

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.

Release files for restoreio 0.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for restoreio 0.10.1
File	Size	Uploaded
restoreio-0.10.1.tar.gz	108.9 kB	Feb 8, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for restoreio 0.10.1
File	Interpreter	ABI	Platform	Reset
restoreio-0.10.1-py3-none-any.whl 142.0 kB Feb 8, 2024	Python 3	none	any	Details

Total release size: 250.9 kB

Release files / restoreio-0.10.1.tar.gz

Download URL	restoreio-0.10.1.tar.gz
Size	108.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`656904bce3e04da6d00446565ce959e701e3806bf36b46153914100ba78cde35`
BLAKE2b-256 checksum How to use checksums	`36b496e9a7189cccb8ff16a625d8e1cd6403ecba050adfc3945a105940002043`
Upload date	Feb 8, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.8`

Release files / restoreio-0.10.1-py3-none-any.whl

Download URL	restoreio-0.10.1-py3-none-any.whl
Size	142.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2eab283478e46649a41941eecdcf7ae0d00835453648bece77409284bab6c4f6`
BLAKE2b-256 checksum How to use checksums	`a5a34807b9e6eefd4180e8305cf61304826c256bc3175f0217f91ac0b5b2cfaa`
Upload date	Feb 8, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.8`