Reconstruct incomplete oceanographic dataset
Project description
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.
Links
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:
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for restoreio-0.6.8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 10940f3f17374a5f27636c56e8b289600ada2372892b0496cd6e73fd39c421e4 |
|
| MD5 | e848438db1596f0ed5652f331430184d |
|
| BLAKE2b-256 | 91974d8d6b4c7b4e2300ba2d71693ec3d7de2a45de9de4c7ad1fdcdbb0789dab |
