Package: radwave
RADWave -Wave analysis from Altimeter dataRADWavedocumentation is found atradwave.readthedocs.ioRADWaveis a python package built to characterisewave conditionsbased on altimeter data.Satellite radar altimeterscan be used to determine significant wave height and wind speed [Young et al., 2011]. Since the first launch of theGEOSAT(GEOdetic SATellite) altimeter in 1985, there has been almost continuous data collection. From these measurements one can calculate wave conditions namely wave height, period and power [Young and Donelan, 2018]. Analysis of this long-term, high resolution spatio-temporal record brings new insights into inter-annual, seasonal and decadal variations of regional wave climates.RADWaveis Python package that provides a mechanism to access altimeter datasets through web-enabled data services (THREDDS). The package capabilities are illustrated based on the the Australian Ocean Data Network (AODNdatabase that spans from 1985-present and that has already been calibrated and validated by [Ribal and Young, 2019].RADWaveallows the user to query over a range of spatial and temporal scales altimeter parameters in specific geographical regions and subsequently calculates significant wave heights, periods, group velocities, average wave energy densities and wave energy fluxes.RADWavecan be used to easily calculate past wave conditions and infers long term wave climate variability, providing new insights on wave modal conditions, seasonal changes, long-term trends and associated modulation by climate oscillations.Designed for researchers and industry partners focusing on offshore wave conditions globally,RADWaveenhances the ease of access and analysis of altimeter data.InstallationDependenciesYou will needPython 3.5+.
Also, the following packages are required:numpyscipypandasscikit-imageseaborngeopycartopynetCDF4shapelypymannkendallInstalling using pipYou can installRADWaveusing thepip package managerwith your version of Python:python3-mpipinstallradwaveInstalling using condaYou can installRADWaveusingcondaby downloading the repository from GitHub. Then you will
use the environment.yml to create the environment. Open a terminal on Linux/Mac or Anaconda Prompt on Windows:cdRADWave/Notebooks
condaenvcreate-fenvironment.yml
condaenvupdate--fileenvironment.yml
condaactivateradwave
jupyternotebookInstalling using DockerA more straightforward installation which does not depend on specific compilers relies on thedockervirtualisation system.To install the docker image and test it is working:dockerpullpyreefmodel/radwave:latestdockerrun--rmpyreefmodel/radwave:latesthelpTo build the dockerfile locally, we provide a script. First ensure you have checked out the source code from github and then run the script in the Docker directory. If you modify the dockerfile and want to push the image to make it publicly available, it will need to be retagged to upload somewhere other than the GEodels repository.gitcheckouthttps://github.com/pyReef-model/RADWave.gitcdRADWavesourceDocker/build-dockerfile.shUsageBinder & docker containerLaunch the demonstration atmybinder.orgAnother option will be to use the Docker container available through Kitematicpyreefmodel/radwave.CollaborationsHow to contribute?We welcome all kinds of contributions!Please get in touch if you would like to help out.Everything fromcodetonotebookstoexamplesanddocumentationare all equally valuable so please don't feel you can't contribute.To contribute pleasefork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.If you found a bug, have questions, or are just having trouble withbioLEC, you can:join theRADWave User Group on Slackby sending an email request to:tristan.salles@sydney.edu.auopen an issue in ourissue-trackerand we'll try to help resolve the concern.Where to find support?Please feel free to submit new issues to theissue-logto request new features, document new bugs, or ask questions.LicenseThis program is free software: you can redistribute it and/or modify it under the terms of theGNU Lesser General Public Licenseas published by theFree Software Foundation, either version 3 of the License, or (at your option) any later version.This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program.  If not, seehttp://www.gnu.org/licenses/lgpl-3.0.en.html.ReferencesRibal, A. and Young, I. R., 2019. 33 years of globally calibrated wave height and wind speed data based on altimeter observations.Scientific Data6(77), p.100.Young, I. R., Zieger, S. and Babanin, A. V., 2011. Global trends in wind speed and wave height.Science332(6028), p451–455.Young, I. R. and Donelan, M., 2018. On the determination of global ocean wind and wave climate from satellite observations.Remote Sensing of Environment215, 228–241.