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 ensembles 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.7	3.8	3.9	3.10	3.11
Linux	X86-64	✔	✔	✔	✔	✔
macOS	X86-64	✔	✔	✔	✔	✔
Windows	X86-64	✖	✔	✔	✔	✔

Documentation

See documentation, including:

Interactive Tutorial

Visit this Jupyter notebook for interactive tutorial.

Usage

An installation of restoreio can be used in two ways: (1) as an importable python package or (2) as a standalone executable in the command line environment.

As a Python Package

You may import restoreio in python. The main functions of this package are:

restoreio.restore: restores incomplete data, generates ensembles, and performs statistical analysis. You may import this function as
```
from restoreio import restore
```
restoreio.scan: performs a pre-scan of your netcdf dataset. You may import this function as
```
from restoreio import scan
```

As a Standalone Executable

Alternatively, you may use restoreio as a standalone executable (outside of python environment) which can be executed in command line. When restoreio is installed, the following executables are available:

restore: This executable is identical to restoreio.restore function in the Python interface.
restore-scan: This executable is identical 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 have additionally developed a web server to serve 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

restoreio-0.6.7.tar.gz (9.4 MB view details)

Uploaded Aug 9, 2023 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

restoreio-0.6.7-py3-none-any.whl (132.8 kB view details)

Uploaded Aug 9, 2023 Python 3

File details

Details for the file restoreio-0.6.7.tar.gz.

File metadata

Download URL: restoreio-0.6.7.tar.gz
Upload date: Aug 9, 2023
Size: 9.4 MB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for restoreio-0.6.7.tar.gz
Algorithm	Hash digest
SHA256	`4ead272187a31c8303211b9b4011c820d80882039977c9ef0010fb1067e86d31`
MD5	`e800b829eedc991bb8268e6a3d65145e`
BLAKE2b-256	`a0b11112c5afe103ef4d030f5b7f0f0d68daa91e5ba9d7486954d797bfecd206`

See more details on using hashes here.

File details

Details for the file restoreio-0.6.7-py3-none-any.whl.

File metadata

Download URL: restoreio-0.6.7-py3-none-any.whl
Upload date: Aug 9, 2023
Size: 132.8 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for restoreio-0.6.7-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9b37dbc30c59a1390c764085cb960937add94efd70c43afb27c2e0b9b815807c`
MD5	`cb195a573113df54f304e4bb094d36f5`
BLAKE2b-256	`85130de74079265144586f3f8d6be7979fa885d031b5c87d50ded1cf8d87380c`