adapter.direct_impacts_integrator.DirectImpacts
adapter.direct_impacts_integrator.DirectImpacts(self, scenario)All information related to the direct impacts of the scenario.
Includes methods to run the impact model or check if it has already been run.
Methods
| Name | Description |
|---|---|
| fiat_has_run_check | Check if fiat has run as expected. |
| has_run_check | Check if the direct impact has been run. |
| preprocess_fiat | Update FIAT model based on scenario information and then runs the FIAT model. |
| run | Run the direct impact model. |
| set_impact_strategy | Set the ImpactStrategy object of the scenario. |
| set_socio_economic_change | Set the SocioEconomicChange object of the scenario. |
fiat_has_run_check
adapter.direct_impacts_integrator.DirectImpacts.fiat_has_run_check()Check if fiat has run as expected.
Returns
| Name | Type | Description |
|---|---|---|
| boolean | True if fiat has run, False if something went wrong |
has_run_check
adapter.direct_impacts_integrator.DirectImpacts.has_run_check()Check if the direct impact has been run.
Returns
| Name | Type | Description |
|---|---|---|
| bool | description |
preprocess_fiat
adapter.direct_impacts_integrator.DirectImpacts.preprocess_fiat()Update FIAT model based on scenario information and then runs the FIAT model.
run
adapter.direct_impacts_integrator.DirectImpacts.run()Run the direct impact model.
set_impact_strategy
adapter.direct_impacts_integrator.DirectImpacts.set_impact_strategy(strategy)Set the ImpactStrategy object of the scenario.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| strategy | str | Name of the strategy used in the scenario | required |
set_socio_economic_change
adapter.direct_impacts_integrator.DirectImpacts.set_socio_economic_change(
projection,
)Set the SocioEconomicChange object of the scenario.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| projection | str | Name of the projection used in the scenario | required |