{"id":34543755,"url":"https://github.com/ameli/restoreio","last_synced_at":"2026-05-26T18:07:19.723Z","repository":{"id":65357922,"uuid":"319205619","full_name":"ameli/restoreio","owner":"ameli","description":"Restore Incomplete Oceanographic Dataset","archived":false,"fork":false,"pushed_at":"2024-10-16T03:23:10.000Z","size":32640,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-02T02:33:14.798Z","etag":null,"topics":["hfradar","incomplete-data","netcdf4","oceanography"],"latest_commit_sha":null,"homepage":"https://ameli.github.io/restoreio","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ameli.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.txt","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-07T04:40:19.000Z","updated_at":"2024-10-16T03:23:15.000Z","dependencies_parsed_at":"2023-12-18T01:01:06.455Z","dependency_job_id":"9c35bd42-b641-4504-b6b7-cf897053f176","html_url":"https://github.com/ameli/restoreio","commit_stats":{"total_commits":103,"total_committers":2,"mean_commits":51.5,"dds":0.04854368932038833,"last_synced_commit":"1f2a6ea5e808bb842a08be0efb79b9d0fbc41d34"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ameli/restoreio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameli%2Frestoreio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameli%2Frestoreio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameli%2Frestoreio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameli%2Frestoreio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ameli","download_url":"https://codeload.github.com/ameli/restoreio/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameli%2Frestoreio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33532537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"ssl_error","status_checked_at":"2026-05-26T15:22:15.568Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hfradar","incomplete-data","netcdf4","oceanography"],"created_at":"2025-12-24T06:53:16.938Z","updated_at":"2026-05-26T18:07:19.717Z","avatar_url":"https://github.com/ameli.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"******\n|logo|\n******\n\n``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.\n\nLinks\n=====\n\n* `Online Gateway \u003chttps://restoreio.org\u003e`__\n* `Documentation \u003chttps://ameli.github.io/restoreio\u003e`__\n* `PyPI \u003chttps://pypi.org/project/restoreio/\u003e`__\n* `Anaconda Cloud \u003chttps://anaconda.org/s-ameli/restoreio\u003e`__\n* `Github \u003chttps://github.com/ameli/restoreio\u003e`__\n\nInstall\n=======\n\nInstall with ``pip``\n--------------------\n\n|pypi|\n\n::\n\n    pip install restoreio\n\nInstall with ``conda``\n----------------------\n\n|conda-version|\n\n::\n\n    conda install -c s-ameli restoreio\n\nSupported Platforms\n===================\n\nSuccessful installation and tests performed on the following operating systems and Python versions:\n\n.. |y| unicode:: U+2714\n.. |n| unicode:: U+2716\n\n+----------+----------+-------+-------+-------+-----------------+\n| Platform | Arch     | Python Version        | Continuous      |\n+          |          +-------+-------+-------+ Integration     +\n|          |          |  3.9  |  3.10 |  3.11 |                 |\n+==========+==========+=======+=======+=======+=================+\n| Linux    | X86-64   |  |y|  |  |y|  |  |y|  | |build-linux|   |\n+          +----------+-------+-------+-------+                 +\n|          | AARCH-64 |  |y|  |  |y|  |  |y|  |                 |\n+----------+----------+-------+-------+-------+-----------------+\n| macOS    | X86-64   |  |y|  |  |y|  |  |y|  | |build-macos|   |\n+          +----------+-------+-------+-------+                 +\n|          | ARM-64   |  |y|  |  |y|  |  |y|  |                 |\n+----------+----------+-------+-------+-------+-----------------+\n| Windows  | X86-64   |  |y|  |  |y|  |  |y|  | |build-windows| |\n+          +----------+-------+-------+-------+                 +\n|          | ARM-64   |  |y|  |  |y|  |  |y|  |                 |\n+----------+----------+-------+-------+-------+-----------------+\n\n.. |build-linux| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/build-linux.yml\n   :target: https://github.com/ameli/restoreio/actions?query=workflow%3Abuild-linux \n.. |build-macos| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/build-macos.yml\n   :target: https://github.com/ameli/restoreio/actions?query=workflow%3Abuild-macos\n.. |build-windows| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/build-windows.yml\n   :target: https://github.com/ameli/restoreio/actions?query=workflow%3Abuild-windows\n\nDocumentation\n=============\n\n|deploy-docs|\n\nSee `documentation \u003chttps://ameli.github.io/restoreio/index.html\u003e`__, including:\n\n* `Installation Guide \u003chttps://ameli.github.io/restoreio/install.html\u003e`__\n* `User Guide \u003chttps://ameli.github.io/restoreio/user_guide/user_guide.html\u003e`__\n* `API Reference \u003chttps://ameli.github.io/restoreio/api.html\u003e`__\n* `Examples \u003chttps://ameli.github.io/restoreio/examples.html\u003e`__\n* `Publications \u003chttps://ameli.github.io/restoreio/cite.html\u003e`__\n\nUsage\n=====\n\nAn installation of ``restoreio`` offers two interfaces: a Python interface and a command-line interface.\n\n1. Python Interface\n-------------------\n\nYou can import ``restoreio`` in python by ``import restoreio``. This package offers the following functions:\n\n* `restoreio.restore \u003chttps://ameli.github.io/restoreio/generated/restoreio.restore.html#restoreio.restore\u003e`__: 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\n\n  ::\n\n    from restoreio import restore\n\n* `restoreio.scan \u003chttps://ameli.github.io/restoreio/generated/restoreio.scan.html#restoreio.scan\u003e`__: 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\n\n  ::\n\n    from restoreio import scan\n\n2. Command-Line Interface\n-------------------------\n\nAlternatively, you may use ``restoreio`` as a standalone application which can be executed in command line. When ``restoreio`` is installed, the following executables are available:\n\n* `restore \u003chttps://ameli.github.io/restoreio/cli_restore.html\u003e`__: This executable is equivalent to ``restoreio.restore`` function in the Python interface.\n* `restore-scan \u003chttps://ameli.github.io/restoreio/cli_scan.html\u003e`__: This executable is equivalent to ``restoreio.scan`` function in the Python interface.\n\nTo 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\n\n::\n\n    export PATH=/opt/minicinda/bin:$PATH\n\nYou may place the above line in ``~/.bashrc`` to make the above change permanently.\n\nOnline Web-Based Interface\n==========================\n\nAlongside ``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 \u003chttps://restoreio.org\u003e`__.\n\nThis 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.\n\nHow to Contribute\n=================\n\nWe welcome contributions via `GitHub's pull request \u003chttps://github.com/ameli/restoreio/pulls\u003e`__. If you do not feel comfortable modifying the code, we also welcome feature requests and bug reports as `GitHub issues \u003chttps://github.com/ameli/restoreio/issues\u003e`__.\n\nHow to Cite\n===========\n\nIf you publish work that uses ``restoreio``, please consider citing the manuscripts available `here \u003chttps://ameli.github.io/restoreio/cite.html\u003e`__.\n\nLicense\n=======\n\n|license|\n\nThis project uses a `BSD 3-clause license \u003chttps://github.com/ameli/restoreio/blob/main/LICENSE.txt\u003e`__, in hopes that it will be accessible to most projects. If you require a different license, please raise an `issue \u003chttps://github.com/ameli/restoreio/issues\u003e`__ and we will consider a dual license.\n\n.. |logo| image:: https://raw.githubusercontent.com/ameli/restoreio/main/docs/source/_static/images/icons/logo-restoreio-light.svg\n   :width: 200\n.. |license| image:: https://img.shields.io/github/license/ameli/restoreio\n   :target: https://opensource.org/licenses/BSD-3-Clause\n.. |deploy-docs| image:: https://img.shields.io/github/actions/workflow/status/ameli/restoreio/deploy-docs.yml?label=docs\n   :target: https://github.com/ameli/restoreio/actions?query=workflow%3Adeploy-docs\n.. |binder| image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/ameli/restoreio/HEAD?filepath=notebooks%2Fquick_start.ipynb\n.. |codecov-devel| image:: https://img.shields.io/codecov/c/github/ameli/restoreio\n   :target: https://codecov.io/gh/ameli/restoreio\n.. |pypi| image:: https://img.shields.io/pypi/v/restoreio\n   :target: https://pypi.org/project/restoreio/\n.. |conda-version| image:: https://img.shields.io/conda/v/s-ameli/restoreio\n   :target: https://anaconda.org/s-ameli/restoreio\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fameli%2Frestoreio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fameli%2Frestoreio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fameli%2Frestoreio/lists"}