https://github.com/ameli/restoreio
Restore Incomplete Oceanographic Dataset
https://github.com/ameli/restoreio
hfradar incomplete-data netcdf4 oceanography
Last synced: 18 days ago
JSON representation
Restore Incomplete Oceanographic Dataset
- Host: GitHub
- URL: https://github.com/ameli/restoreio
- Owner: ameli
- License: bsd-3-clause
- Created: 2020-12-07T04:40:19.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T03:23:10.000Z (over 1 year ago)
- Last Synced: 2025-12-02T02:33:14.798Z (6 months ago)
- Topics: hfradar, incomplete-data, netcdf4, oceanography
- Language: Python
- Homepage: https://ameli.github.io/restoreio
- Size: 31.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE.txt
- Authors: AUTHORS.txt
Awesome Lists containing this project
README
******
|logo|
******
``restoreio`` is a Python package to **Restore** **I**\ ncomplete **O**\ ceanographic 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.
Links
=====
* `Online Gateway `__
* `Documentation `__
* `PyPI `__
* `Anaconda Cloud `__
* `Github `__
Install
=======
Install with ``pip``
--------------------
|pypi|
::
pip install restoreio
Install with ``conda``
----------------------
|conda-version|
::
conda install -c s-ameli restoreio
Supported Platforms
===================
Successful installation and tests performed on the following operating systems and Python versions:
.. |y| unicode:: U+2714
.. |n| unicode:: U+2716
+----------+----------+-------+-------+-------+-----------------+
| Platform | Arch | Python Version | Continuous |
+ | +-------+-------+-------+ Integration +
| | | 3.9 | 3.10 | 3.11 | |
+==========+==========+=======+=======+=======+=================+
| Linux | X86-64 | |y| | |y| | |y| | |build-linux| |
+ +----------+-------+-------+-------+ +
| | AARCH-64 | |y| | |y| | |y| | |
+----------+----------+-------+-------+-------+-----------------+
| macOS | X86-64 | |y| | |y| | |y| | |build-macos| |
+ +----------+-------+-------+-------+ +
| | ARM-64 | |y| | |y| | |y| | |
+----------+----------+-------+-------+-------+-----------------+
| Windows | X86-64 | |y| | |y| | |y| | |build-windows| |
+ +----------+-------+-------+-------+ +
| | ARM-64 | |y| | |y| | |y| | |
+----------+----------+-------+-------+-------+-----------------+
.. |build-linux| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/build-linux.yml
:target: https://github.com/ameli/restoreio/actions?query=workflow%3Abuild-linux
.. |build-macos| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/build-macos.yml
:target: https://github.com/ameli/restoreio/actions?query=workflow%3Abuild-macos
.. |build-windows| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/build-windows.yml
:target: https://github.com/ameli/restoreio/actions?query=workflow%3Abuild-windows
Documentation
=============
|deploy-docs|
See `documentation `__, including:
* `Installation Guide `__
* `User Guide `__
* `API Reference `__
* `Examples `__
* `Publications `__
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
=======
|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.
.. |logo| image:: https://raw.githubusercontent.com/ameli/restoreio/main/docs/source/_static/images/icons/logo-restoreio-light.svg
:width: 200
.. |license| image:: https://img.shields.io/github/license/ameli/restoreio
:target: https://opensource.org/licenses/BSD-3-Clause
.. |deploy-docs| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/deploy-docs.yml?label=docs
:target: https://github.com/ameli/restoreio/actions?query=workflow%3Adeploy-docs
.. |binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/ameli/restoreio/HEAD?filepath=notebooks%2Fquick_start.ipynb
.. |codecov-devel| image:: https://img.shields.io/codecov/c/github/ameli/restoreio
:target: https://codecov.io/gh/ameli/restoreio
.. |pypi| image:: https://img.shields.io/pypi/v/restoreio
:target: https://pypi.org/project/restoreio/
.. |conda-version| image:: https://img.shields.io/conda/v/s-ameli/restoreio
:target: https://anaconda.org/s-ameli/restoreio