atomica.cascade.cascade_summary

atomica.cascade.cascade_summary(source_data, year, pops=None, cascade=0)[source]

Print summary of cascade

This function takes in results, either as a Result or list of Results, or as a CascadeEnsemble.

Parameters:

  • source_data – A Result or a CascadeEnsemble

  • year (float) – A scalar year to print results in

  • pops – If a Result was passed in, this can be any valid population aggregation. If a CascadeEnsemble was passed in, then this must match the name of one of the population aggregations stored in the Ensemble (i.e. it must be an item contained in CascadeEnsemble.pops)

  • cascade – If a Result was passed in, this argument specifies which cascade to use. If a CascadeEnsemble was passed in, then this argument is ignored because the CascadeEnsemble already uniquely specifies the cascade

  • pretty – If True, absolute values will be rounded to integers and percentages to 2 sig figs

Return type:

None

Returns: