Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 3.47 KB

README.md

File metadata and controls

84 lines (59 loc) · 3.47 KB
Raw

EddyProfSync: A MATLAB tools for collocating coherent eddy and hydrographic datasets

The EddyProfSync is a MATLAB - based tool designed to identify profiles that are surfaced in mesoscale eddies.

DOI

Table of Content

  1. Installation
  2. Functions
  3. Tutorials
  4. Contributing
  5. Contact
  6. Acknowledgement
  7. Citation

Installation

The EddyProfSync is a standard MATLAB toolbox-style software. Therefore, it can be installed directly by downloading this repository and adding it to the path in your MATLAB.

Alternatively, you can start your script with:

addpath('path-to-the-EddyProfileCollocator-repo')

Functions

Functions are stored in two directories, namely, src and utils.

The source directory (src/) :

Function Description
find_profineddy() To collocate eddies and profile, uses collocateeddynprof()
collocateeddynprof() To match eddies and surfaced profile

The additional function directory (utils/) :

Function Description
Ecode2voaygenums() To create indices from voyage name and station ID
myargoindex() To create indices from Argo float WMO and Cycle Number
omitvirtualeddy4mMETA() To remove virtual eddies from META eddies
ra_fagwithshape2meta() To convert Chalton's table to META format
ra_get_lon_lat_time() To extract spatio-temporal information from Argo data
ra_getlonlattimeIncol() same as ra_get_lon_lat_time but all outputs are in column
ra_importdata_interp() To extract Argo parameters after QCing for a given float WMO and Cycle Number

NOTE: The detailed usage of each of these functions is elucidated in the following tutorials.

Examples

Collocate eddies and in-situ profiles:
This notebook demonstrates how to identify in-situ profiles that are surfaced in mesoscale eddies using historical observations.

Collocate eddies and BGC-Argo profiles:
This notebook demonstrates the collocation of mesoscale eddies and BGC-Argo profiles in the Southern Ocean.

Contributing

If you find a bug, have a question, or want to contribute, please open an issue or email Ramkrushn Patel.

Detailed version of How to contribute will be provided in doc/ directory.

Contact

Ramkrushnbhai S. Patel

IMAS, University of Tasmania
ARC Centre of Excellence for Climate System Science (CLEX)

Email: Ramkrushn Patel

Acknowledgement

Citation

While this work is under consideration for publication in JOSS, please use following citation.

Patel, R. S. (2024). EddyProfSync: A MATLAB tools for collocating coherent eddy and hydrographic datasets (1.0.0). Zenodo. https://doi.org/10.5281/zenodo.10453071