feisty.feisty_instance_type

class feisty.feisty_instance_type(domain_dict, settings_dict={}, fish_ic_data=1e-05, benthic_prey_ic_data=0.002, biomass_init_file=None, biomass_slice=None)

This is the primary interface to the FEISTY model.

Parameters:

• domain_dict (dict) –

  Dictionary containing domain information, for example:

  domain_dict = {
      'NX': len(bathymetry_data),
      'bathymetry': bathymetry_data)),
  }
  

• settings_dict (dict, optional) – Dictionary of model settings.

• fish_ic_data (numeric or array_like, optional) – Initial conditions for fish biomass.

• benthic_prey_ic_data (numeric or array_like) – Initial conditions for benthic prey biomass.

Examples

Initialize the FEISTY model and return a feisty_instance_type object:

import feisty
domain = get_model_domain()
feisty_instance = feisty_instance_type(domain_dict=domain)

In the context of time-stepping the model forward, the tendencies are computed as follows:

dXdt = feisty_instance.compute_tendencies(...)

Then information from the computation can be accessed as an xarray.Dataset via the tendency_data property:

ds_t = feisty_instance.tendency_data

__init__(domain_dict, settings_dict={}, fish_ic_data=1e-05, benthic_prey_ic_data=0.002, biomass_init_file=None, biomass_slice=None)

Initialize the feisty_instance_type.

Methods

__init__(domain_dict[, settings_dict, ...])	Initialize the feisty_instance_type.
compute_tendencies(fish_biomass, ...)	Compute time tendency for FEISTY model.
get_prognostic()	Return array of prognostic biomass components.