Interface API

These are the full docstrings for miscellaneous objects (generally not user-facing).

General utilities

Sargassum.vec2range Function

vec2range(vector; force)

Convert a Vector of linearly spaced values to a StepRangeLen.

If force == true, the range will be constructed even if the vector isn't linearly spaced by linear interpolation preserving the length. Default false.

source

Clump utilities

Sargassum.clump_i Function

clump_i(u, i)

Return a view to the the [x, y] coordinates of the ith clump in the solution matrix u. This is view(u :,i).

source

Sargassum.com Function

com(u)

Return the center of mass [x, y] coordinates of the solution matrix u.

source

Downloading

Sargassum._download_with_progress Function

_download_with_progress(url, output_path)

Download file from url to output_path with a progress bar.

source

Sargassum._download_with_progress_http Function

_download_with_progress_http(url, [local_path], [headers]; update_period=1, kw...)

Simular to [_download_with_progress], but suitable for downloading .nc files from https://cwcgom.aoml.noaa.gov/erddap/griddap.

source

Scratch spaces

Sargassum._AFAI_RAW_SCRATCH Constant

const _AFAI_RAW_SCRATCH

A Ref whose field is the path to the location of the raw AFAI data.

source

Sargassum._SARGASSUM_DISTRIBUTION_PRECOMPUTED_SCRATCH Constant

const _SARGASSUM_DISTRIBUTION_PRECOMPUTED_SCRATCH

A Ref whose field is the path to the location of the precomputed [SargassumDistribution(@ref)s.

source

Sargassum._ITPS_RAW_SCRATCH Constant

const _ITPS_RAW_SCRATCH

A Ref whose field is the path to the location of the raw data that generates default interpolants.

source

Sargassum._ITPS_SCRATCH Constant

const _ITPS_RAW_SCRATCH

A Ref whose field is the path to the location of the raw data that generates default interpolants.

source

Sargassum._INTERFACE_SCRATCH Constant

const _INTERFACE_SCRATCH

A Ref whose field is the path to the location of the editable interface notebook.

source

Geometry

Sargassum.geo2basic Function

geo2basic(input)

Takes any GeoInterface-compatible structure, and returns its equivalent in the GeometryBasics.jl package, which Makie is built on.

Currently works for the following traits:

- PointTrait
- LineTrait
- LineStringTrait
- PolygonTrait
- MultiPolygonTrait

source