Skip to content

Latest commit

 

History

History
81 lines (64 loc) · 5.33 KB

ReadMe.md

File metadata and controls

81 lines (64 loc) · 5.33 KB
Raw

World Ocean Atlas Tools

DOI License: MIT

Simple usage

Just add WorldOceanAtlasTools like any other Julia package, and then you can grab the data with, e.g.,

julia> WorldOceanAtlasTools.observations("PO₄")
Registering World Ocean Atlas data with DataDeps
┌ Warning: You are about to use World Ocean Atlas data.
│ Please cite the following corresponding reference(s):
│ Garcia, H. E., K. Weathers, C. R. Paver, I. Smolyar, T. P. Boyer, R. A. Locarnini, M. M. Zweng, A. V. Mishonov, O. K. Baranova, D. Seidov, and J. R. Reagan, 2018. World Ocean Atlas 2018, Volume 4: Dissolved Inorganic Nutrients (phosphate, nitrate and nitrate+nitrite, silicate). A. Mishonov Technical Ed.; in preparation.)
└ @ WorldOceanAtlasTools ~/.julia/dev/WorldOceanAtlasTools/src/functions.jl:218
1312523×4 DataFrame
     Row │ lat      lon      depth      PO₄
         │ Float32  Float32  Quantity…  Quantity…
─────────┼────────────────────────────────────────────────
       1 │   -77.5   -178.5      0.0 m  1.35075 μmol kg⁻¹
       2 │   -77.5   -177.5      0.0 m  1.28211 μmol kg⁻¹
       3 │   -77.5   -176.5      0.0 m  1.37447 μmol kg⁻¹
    ⋮    │    ⋮        ⋮         ⋮              ⋮
 1312521 │    52.5   -165.5   5500.0 m  2.4566 μmol kg⁻¹
 1312522 │    52.5   -163.5   5500.0 m  2.42341 μmol kg⁻¹
 1312523 │    53.5   -158.5   5500.0 m  2.45224 μmol kg⁻¹
                                      1312517 rows omitted

Why this package?

WorldOceanAtlasTools.jl was developed for the purpose of downloading and using data from the World Ocean Atlas (WOA) database to be used by the AIBECS.jl package. The more generic ambition is for WorldOceanAtlasTools.jl to provide an API that can fetch data from this list of WOA data sets and products (located on the National Oceanic and Atmospheric Administration (NOAA) wesbite) and fit it to any model's grid.

This is a work in progress, therefore PRs, suggestions, and generally help are, of course, more than welcome!

How it works

WorldOceanAtlasTools.jl essentially defines the nomenclature and URLs used by the WOA and then relies on the DataDeps.jl package developed by White et al. (2018) to download the corresponding NetCDF files. (NetCDF files are read using the NCDatasets.jl package.)

In order to facilitate the use of WOA data in AIBECS.jl, the WorldOceanAtlasTools.jl package can use a grid from the OceanGrids.jl package and bin a WOA tracer into that grid, and uses the NearestNeighbors.jl package to decide where to bin each observation.

But you can also use it as in the example snippet above by simply calling the function observations.

Cite me if you use me!

If you use this package, please cite it using the CITATION.bib file, and cite the WOA references using the citation function or use the corresponding bibtex entries in the CITATION.bib file.