support.input_functions module

support.input_functions module#

input_functions.py#

Collection of functions written for model inputs.

Functions included:
  • load_data

    Load all model data for all variables and all years.

  • results_instructions

    Read results instruction file.

support.input_functions.load_data(titles, dimensions, timeline, scenarios, ftt_modules, forstart, progress_callback=None)#

Load all model data for all variables and all years.

Parameters:

  • titles (dictionary of lists) – Dictionary containing all title classifications

  • dimensions (dict of tuples (str, str, str, str)) – Variable classifications by dimension

  • timeline (list of int) – Years of both historical data and forecast period

  • scenarios (str) – Comma-separated scenario names

  • ftt_modules (str) – Comma-separated module names

  • forstart (dict) – Dictionary of forecast start years

  • progress_callback (callable, optional) – Function(current, total) to report progress

Returns:

data_return – Dictionary containing all required model input variables.

Return type:

dictionary of numpy arrays

support.input_functions.results_instructions()#

Read result instruction file.