PSM.bayfox.bayfox

Creates a new BayFOX PSM object

Syntax


obj = PSM.bayfox(species)
obj = PSM.bayfox(species, ‘d18O’, d18Osw)
obj = PSM.bayfox(species, ‘SST’, sst)

Description


obj = PSM.bayfox(species)

Initializes a new BayFOX PSM object for a particular foraminiferal species. The PSM will require both SST and d18Osw inputs from the state vector ensemble.


obj = PSM.bayfox(species, ‘d18O’, d18Osw)

Uses a fixed value of d18O when running the model. The PSM will only require SST inputs from the state vector ensemble.


obj = PSM.bayfox(species, ‘SST’, sst)

Uses a fixed SST value when running the model. The PSM will only require d18Osw inputs from the state vector ensemble.

Input Arguments

species

species

string scalar

Name of the target species. Please see the documentation of the “bayfox_forward.m” function in the “bayfoxm” repository for valid species strings

d18Osw

d18Osw

numeric scalar

A fixed d18O_sea-water value (in VSMOW) to use when running the PSM

sst

sst

numeric scalar

A fixed SST value (in Celsius) to use when running the PSM

Output Arguments

obj

obj

scalar PSM.*bayfox* object

The new BayFOX PSM object