Known FINAM modules

This chapter lists known components and adapters for use in FINAM compositions.

Included in FINAM core package

Components

Several components, primarily for testing and debugging, are provided in module finam.modules.

CallbackComponent(inputs, outputs, callback, ...)	Component to generate, transform or consume data in fixed time intervals using a callback.
CallbackGenerator(callbacks, start, step)	Component to generate data in fixed time intervals from multiple callbacks.
CsvReader(path, time_column, outputs[, ...])	Reads CSV time series with one row per time step, and emits values based on a time column.
CsvWriter(path, start, step, inputs[, ...])	Writes CSV time series with one row per time step, from multiple inputs.
DebugConsumer(inputs, start, step[, ...])	Generic component with arbitrary inputs and extensive debug logging.
DebugPushConsumer(inputs[, callbacks, ...])	Generic component with arbitrary inputs and extensive debug logging.
ParametricGrid([info, func])	Pull-based parametric grid generator.
ScheduleLogger(inputs[, time_step, ...])	Logging of module update schedule.
SimplexNoise([info, frequency, ...])	Pull-based simplex noise generator.
StaticCallbackGenerator(callbacks)	Component to generate static data from multiple callbacks.
StaticParametricGrid([info, func])	Static parametric grid generator.
StaticSimplexNoise([info, frequency, ...])	Static simplex noise generator.
TimeTrigger(start, step[, in_info, ...])	Component to forward data in regular time intervals.
UserControl(start[, step])	Component to allow users to step a simulation.
WeightedSum(inputs[, grid])	Pull-based component to merge inputs by weighted sum.

Adapters

Different general-purpose adapters are provided in module finam.adapters.

Base adapters

Callback(callback)	Transform data using a callback.
Scale(scale)	Scales the input.
ValueToGrid(grid)	Convert a scalar value to a Matrix filled with that value.
GridToValue(func)	Convert a matrix to a scalar value using an aggregation function, e.g. numpy.mean.

Probe adapters

CallbackProbe(callback)

Probe data by calling a callback.

Regridding adapters

See also package finam-regrid for more advanced regridding.

RegridNearest([in_grid, out_grid, tree_options])	Regrid data between two grid specifications with nearest neighbour interpolation.
RegridLinear([in_grid, out_grid, ...])	Regrid data between two grid specifications with linear interpolation.

Statistics adapters

Histogram(lower, upper[, bins, density])

Calculates a histogram over grid values.

Time adapters

LinearTime()	Linear time interpolation.
NextTime()	Time interpolation providing the next future value.
PreviousTime()	Time interpolation providing the newest past value.
StackTime()	Stacks all incoming data since the last push.
StepTime([step])	Step-wise time interpolation.
AvgOverTime([step])	Aggregates data over time to form the temporal average over the last pull time step.
SumOverTime([step, per_time, initial_interval])	Aggregates data over time to form the temporal sum (area under curve) over the last pull time step.
DelayFixed(delay)	Delays/offsets the request time by subtracting a fixed offset.
DelayToPush()	Delays/offsets the request time to the last push time if out of range.
DelayToPull([steps, additional_delay])	Delays/offsets the request time to a previous pull time.
TimeCachingAdapter()	Abstract base class for time handling and caching adapters.

Provided by FINAM developers

Components

• finam-plot

  FINAM components for live plotting using matplotlib.

• finam-netcdf

  FINAM components for NetCDF file reading and writing.

Adapters

• finam-regrid

  FINAM adapter for advances regridding using ESMPy.

Tools

• finam-graph

  A tool for visualizing FINAM coupling setups.

Known 3rd party

None