Skip to content

Sequential models

Sequential models are models where the equations are simulated sequentially, one data point at a time. The order of execution in simulations is either period-by-period and equation-by-equation, or vice versa, equation-by-equation and period-by-period.

Directly accessible properties

Property Description
all_names Names of all variables occurring in the model in order of appearance
equation_strings Equation strings in order of appearance
identity_index Indexes of identity equations
incidence_matrix Incidence matrix with equations in rows and LHS quantities in columns
is_sequential True if the model equations are ordered sequentially
lhs_names Unique names of LHS variables in order of their first appearance in equations
lhs_names_in_equations Names of LHS variables in order of their appearance in equations
lhs_quantities LHS quantities in order of appearance
max_lag Maximum lag occurring on the RHS of equations
max_lead Maximum lead occurring on the RHS of equations
nonidentity_index Indexes of nonidentity equations
num_equations Number of equations
num_lhs_names Number of unique LHS names
parameter_names Names of model parameters
residual_names Unique names of residuals in order of their first appearance in equations
residual_names_in_equations Names of residuals in order of their appearance in equations
rhs_only_names Names of variables appearing only on the RHS of equations

Categorical list of functions

Creating new Sequential models

Function Description
Sequential.from_file Create new Sequential model object from source file or files
Sequential.from_string Create sequential model object from string

Getting information about Sequential models

Function Description
get_description Get model description text
set_description Set model description text

Simulating Sequential models

Function Description
simulate Simulate sequential model

Manipulating Sequential model parameters

Function Description
assign Assign model parameters
check_missing_parameters Check for missing parameters
get_parameters Get model parameters

Manipulating Sequential models

Function Description
copy Create a deep copy
reorder_equations Reorder model equations
sequentialize Reorder the model equations so that they can be solved sequentially

☐ Sequential.from_file

Create new Sequential model object from source file or files

self = Sequential.from_file(
    file_names,
    *,
    context=None,
    description="",
)

Read and parse one or more source files specified by file_names (a string or a list of strings) with model source code, and create a Sequential model object.

Input arguments

file_names

The name of the model source file from which the Sequential model object will be created, or a list of file names; if multiple file names are specified, they will all combined together in the given order.

context

Dictionary supplying the values used in preparsing commands, and the definition of non-standard functions used in the equations.

description

Description of the model specified as a text string.

Returns

self

A new Sequential model object created from the file_names.

☐ Sequential.from_string

Create sequential model object from string

self = Sequential.from_string(
    string,
    *,
    context=None,
    description="",
)

Read and parse a text string with a model source code, and create a Sequential model object. Otherwise, this function behaves the same way as Sequential.from_file.

Input arguments

string

Text string from which the Sequential model object will be created.

See Sequential.from_file for other input arguments.

Returns

See Sequential.from_file for return values.

☐ assign

Assign model parameters

Assigns parameters to a Sequential model. The method can assign parameters from individual arguments, from a Databox, or from a dict.

Assigning individual parameters

self.assign(
    name_one=value_one,
    name_two=value_two,
    # etc
)

Assigning parameters from a Databox or a dict

self.assign(databox, )

Input arguments

self

Sequential model whose parameters will be assigned.

name_one, name_two, ...

Names of the parameters to assign.

value_one, value_two, ...

Values to assign to name_one, name_two, etc.

databox

Databox or dict from which the parameters will be extracted and assigned. Any names in the Databox or dict that are not model parameters will be ignored.

Returns

None

This method modifies self in-place and does not return a value.

☐ check_missing_parameters

Check for missing parameters

Raises an error if any of the model parameters are missing values.

self.check_missing_parameters()

Input arguments

self

Sequential model to check for missing parameters.

Returns

Returns no value; raises an error if any parameters are missing, and prints the list of missing parameter names.

☐ copy

Create a deep copy

other = self.copy()

Input arguments

self

A Sequential model object to be copied.

Returns

other

A deep copy of self.

☐ get_description

Get model description text

description = self.get_description()

Input arguments

self

Sequential model object whose description will be returned.

Returns

Description of self.

☐ get_parameters

Get model parameters

Returns a Databox with the parameter values currently assigned within a Sequential model.

parameters = self.get_parameters(*, unpack_singleton=True, )

Input arguments

self

Sequential model whose parameters will be retrieved.

unpack_singleton

If True, the method will unpack the parameters values for models with a single parameter variant.

Returns

parameters

Databox with the model parameters.

☐ reorder_equations

Reorder model equations

self.reorder_equations(new_order, )

Reorder the model equations within self according to the new_order of equation indexes.

Input arguments

self

Sequential model object whose equations will be reordered.

new_order

New order of model equations specified as a list of equation indexes (integers starting from 0).

☐ sequentialize

Reorder the model equations so that they can be solved sequentially

eids_reordered = self.sequentialize()

Reorder the model equations within self so that they can be solved sequentially. The reordered equation indexes are returned as a tuple.

Input arguments

self

Sequential model object whose equations will be reordered sequentially.

Returns

eids_reordered

Tuple of equation indexes (integers starting from 0) specifying the new order of equations.

☐ set_description

Set model description text

self.set_description(description, )

...

Input arguments

self

Sequential model object whose description will be set.

description

New description of self.

☐ simulate

Simulate sequential model

Simulate a Sequential model, self, on a time span, period by period, equation by equation. The simulate function does not reorder the equations; if needed, this must be done by running reorder before simulating the model.

out_db = self.simulate(
input_db,
simulation_span,
*,
plan=None,
execution_order="dates_equations",
prepend_input=True,
target_db=None,
when_simulates_nan="warning",
num_variants=None,
remove_initial=True,
remove_terminal=True,
return_info=False,
)

out_db, info = self.simulate(
...,
return_info=True,
...,
)

Input arguments

self

Sequential model that will be simulated.

input_db

Input databox (a Databox object) with all the necessary initial conditions (initial lags) for the LHS variables, and all the values for the RHS variables needed to simulate self on the time span.

plan

PlanSimulate object with a simulation plan, i.e. information about which LHS variables to exogenize at which dates. If plan=None, no simulation plan is imposed on the simulation.

simulation_span

Time span for the simulation; the time span needs to go forward and have a one-period step.

plan

Simulation plan for the simulation specifying the exogenized data points. If None, no simulation plan is imposed.

prepend_input

If True, the input time series observations are prepended to the results.

target_db

Custom databox to which the simulated time series will be added. If None, a new databox is created.

when_simulates_nan

Action to take when a simulated data point is non-finite (nan or inf or -inf). The options are

  • "error": raise an error,
  • "warning": log a warning,
  • "silent": do nothing.
execution_order

Order in which the model equations and simulation periods are executed. The options are

  • "dates_equations": all equations for the first period, all equations for the second period, …
  • "equations_dates": all periods for the first equation, all periods for the second equation, …
num_variants

Number of variants to simulate. If None, the number of variants is determined by the number of variants in the self model.

remove_initial

If True, remove the initial condition data, i.e. all lags before the start of the simulation span.

remove_terminal

If True, remove the terminal condition data, i.e. all leads after the end of the simulation span.

Returns

out_db

Output databox with the simulated time series for the LHS variables.

info

(Only returned if return_info=True which is not the default behavior) Dictionary with information about the simulation;info` contains the following items:

Key Description
"method" Simulation method used
"execution_order" Execution order of the equations and periods