Package: restoreio
restoreiois a Python package toRestoreIncompleteOceanographic 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.LinksOnline GatewayDocumentationPyPIAnaconda CloudGithubInstallInstall withpippip install restoreioInstall withcondaconda install -c s-ameli restoreioSupported PlatformsSuccessful installation and tests performed on the following operating systems and Python versions:PlatformArchPython VersionContinuous
Integration3.93.103.11LinuxX86-64✔✔✔AARCH-64✔✔✔macOSX86-64✔✔✔ARM-64✔✔✔WindowsX86-64✔✔✔ARM-64✔✔✔DocumentationSeedocumentation, including:Installation GuideUser GuideAPI ReferenceExamplesPublicationsUsageAn installation ofrestoreiooffers two interfaces: a Python interface and a command-line interface.1. Python InterfaceYou can importrestoreioin python byimport 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 byfrom restoreio import restorerestoreio.scan: This function performs a pre-scan of your NetCDF dataset and ensures your dataset is compatible as an input torestoreio.restorefunction. 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 forrestoreio.restorefunction. You can import this function byfrom restoreio import scan2. Command-Line InterfaceAlternatively, you may userestoreioas a standalone application which can be executed in command line. Whenrestoreiois installed, the following executables are available:restore: This executable is equivalent torestoreio.restorefunction in the Python interface.restore-scan: This executable is equivalent torestoreio.scanfunction in the Python interface.To use these executables, make sure the/bindirectory of your Python installation is set on yourPATHenvironment variable. For instance, if your Python is installed on/opt/minicinda3/, add this path/opt/miniconda3/bindirectory toPATHbyexport PATH=/opt/minicinda/bin:$PATHYou may place the above line in~/.bashrcto make the above change permanently.Online Web-Based InterfaceAlongsiderestoreiopython 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 ContributeWe welcome contributions viaGitHub’s pull request. If you do not feel comfortable modifying the code, we also welcome feature requests and bug reports asGitHub issues.How to CiteIf you publish work that usesrestoreio, please consider citing the manuscripts availablehere.LicenseThis project uses aBSD 3-clause license, in hopes that it will be accessible to most projects. If you require a different license, please raise anissueand we will consider a dual license.