metawards.iterators.iterate_weekend¶

metawards.iterators.iterate_weekend(nthreads: int = 1, **kwargs)[source]¶

This returns the default list of ‘advance_XXX’ functions that are called in sequence for each weekend iteration of the model run.

Parameters: nthreads (int) – The number of threads that will be used for each function. If this is 1, then the serial versions of the functions will be returned, else the parallel (OpenMP) versions will be returned
Returns: funcs – The list of functions that `iterate` will call in sequence
Return type: List[function]