How to use LandSea.jl

As mentioned on the home page, LandSea.jl is a backend package that allows a user to import and handle land-sea masks and topographic data. Examples of such land-sea mask datasets include:

• ERA5 reanalysis land-sea masks and topographic data (0.25º or T639 spectral)

• NASA IMERG land-sea mask (0.1º)

• ETOPO topographic datasets, with land-sea mask estimation

Retrieving a LandSea Dataset

To retrieve Land-Sea dataset, we recommend extending the getLandSea() function exported by LandSea.jl as needed via the following method:

import LandSea: getLandSea

function getLandSea(
    ids :: <Dataset Type of Interest>,
    geo :: GeoRegion
)

...

end

See the docs below:

LandSea.getLandSea Function

getLandSea

An extensible function type to retrieve LandSea Datasets. You can use this function name in your packages if you want to retrieve a specific LandSea dataset.

getLandSea(
    ids :: <Dataset Type of Interest>,
    geo :: GeoRegion
) -> LandSeaData

Arguments

• ids : A struct type for the dataset of interest (e.g., a NASAPrecipitationDataset)

• geo : A GeoRegion structure type

source

Examples

The following packages serve as examples of how LandSea.jl can be used to download topographic and land-sea mask information:

• ERA5Reanalysis.jl (GitHub) (documentation) (source code)

• NASAPrecipitation.jl (GitHub) (documentation) (source code)