From 1edf78fe7e7e5de5415612c29d5fd24a279b4c4a Mon Sep 17 00:00:00 2001 From: spjuhel Date: Fri, 25 Oct 2024 15:31:07 +0200 Subject: [PATCH] updates repo rst files --- .../_autosummary/boario.event.Event.rst | 27 +---------- .../boario.event.EventArbitraryProd.rst | 31 ++---------- .../boario.event.EventKapitalDestroyed.rst | 30 ++---------- .../boario.event.EventKapitalRebuild.rst | 36 ++------------ .../boario.event.EventKapitalRecover.rst | 33 ++----------- docs/source/_autosummary/boario.event.rst | 8 ++++ .../boario.extended_models.ARIOPsiModel.rst | 47 +++++++++---------- .../boario.model_base.ARIOBaseModel.rst | 47 +++++++++---------- docs/source/_autosummary/boario.rst | 5 ++ .../boario.simulation.Simulation.rst | 10 +++- .../source/_autosummary/boario.simulation.rst | 1 + 11 files changed, 85 insertions(+), 190 deletions(-) diff --git a/docs/source/_autosummary/boario.event.Event.rst b/docs/source/_autosummary/boario.event.Event.rst index c9a993e..e958d3d 100644 --- a/docs/source/_autosummary/boario.event.Event.rst +++ b/docs/source/_autosummary/boario.event.Event.rst @@ -16,12 +16,8 @@ Event .. autosummary:: ~Event.__init__ - ~Event.distribute_impact_by_gva - ~Event.distribute_impact_equally - ~Event.from_dataframe - ~Event.from_scalar_industries + ~Event.distribute_impact_industries ~Event.from_scalar_regions_sectors - ~Event.from_series @@ -31,32 +27,13 @@ Event .. autosummary:: - ~Event.Y_distrib - ~Event.Z_distrib ~Event.aff_industries ~Event.aff_regions - ~Event.aff_regions_idx ~Event.aff_sectors - ~Event.aff_sectors_idx ~Event.duration - ~Event.gva_df - ~Event.impact_df + ~Event.impact ~Event.impact_industries_distrib ~Event.impact_regional_distrib - ~Event.model_monetary_factor - ~Event.mrio_name ~Event.occurrence - ~Event.possible_final_demand_cat - ~Event.possible_regions - ~Event.possible_sectors - ~Event.regions_idx - ~Event.sectors_gva_shares - ~Event.sectors_idx - ~Event.temporal_unit_range - ~Event.x_shape - ~Event.y_shape - ~Event.z_shape ~Event.name - ~Event.happened - ~Event.over ~Event.event_dict diff --git a/docs/source/_autosummary/boario.event.EventArbitraryProd.rst b/docs/source/_autosummary/boario.event.EventArbitraryProd.rst index 66702b2..d10df63 100644 --- a/docs/source/_autosummary/boario.event.EventArbitraryProd.rst +++ b/docs/source/_autosummary/boario.event.EventArbitraryProd.rst @@ -16,13 +16,8 @@ EventArbitraryProd .. autosummary:: ~EventArbitraryProd.__init__ - ~EventArbitraryProd.distribute_impact_by_gva - ~EventArbitraryProd.distribute_impact_equally - ~EventArbitraryProd.from_dataframe - ~EventArbitraryProd.from_scalar_industries + ~EventArbitraryProd.distribute_impact_industries ~EventArbitraryProd.from_scalar_regions_sectors - ~EventArbitraryProd.from_series - ~EventArbitraryProd.recovery @@ -32,36 +27,16 @@ EventArbitraryProd .. autosummary:: - ~EventArbitraryProd.Y_distrib - ~EventArbitraryProd.Z_distrib ~EventArbitraryProd.aff_industries ~EventArbitraryProd.aff_regions - ~EventArbitraryProd.aff_regions_idx ~EventArbitraryProd.aff_sectors - ~EventArbitraryProd.aff_sectors_idx ~EventArbitraryProd.duration - ~EventArbitraryProd.gva_df - ~EventArbitraryProd.impact_df + ~EventArbitraryProd.impact ~EventArbitraryProd.impact_industries_distrib ~EventArbitraryProd.impact_regional_distrib - ~EventArbitraryProd.model_monetary_factor - ~EventArbitraryProd.mrio_name ~EventArbitraryProd.occurrence - ~EventArbitraryProd.possible_final_demand_cat - ~EventArbitraryProd.possible_regions - ~EventArbitraryProd.possible_sectors ~EventArbitraryProd.prod_cap_delta_arbitrary - ~EventArbitraryProd.recoverable ~EventArbitraryProd.recovery_function - ~EventArbitraryProd.regions_idx - ~EventArbitraryProd.sectors_gva_shares - ~EventArbitraryProd.sectors_idx - ~EventArbitraryProd.temporal_unit_range - ~EventArbitraryProd.x_shape - ~EventArbitraryProd.y_shape - ~EventArbitraryProd.z_shape - ~EventArbitraryProd.recovery_time + ~EventArbitraryProd.recovery_tau ~EventArbitraryProd.name - ~EventArbitraryProd.happened - ~EventArbitraryProd.over ~EventArbitraryProd.event_dict diff --git a/docs/source/_autosummary/boario.event.EventKapitalDestroyed.rst b/docs/source/_autosummary/boario.event.EventKapitalDestroyed.rst index 0e27e90..1f1b781 100644 --- a/docs/source/_autosummary/boario.event.EventKapitalDestroyed.rst +++ b/docs/source/_autosummary/boario.event.EventKapitalDestroyed.rst @@ -16,12 +16,8 @@ EventKapitalDestroyed .. autosummary:: ~EventKapitalDestroyed.__init__ - ~EventKapitalDestroyed.distribute_impact_by_gva - ~EventKapitalDestroyed.distribute_impact_equally - ~EventKapitalDestroyed.from_dataframe - ~EventKapitalDestroyed.from_scalar_industries + ~EventKapitalDestroyed.distribute_impact_industries ~EventKapitalDestroyed.from_scalar_regions_sectors - ~EventKapitalDestroyed.from_series @@ -31,35 +27,15 @@ EventKapitalDestroyed .. autosummary:: - ~EventKapitalDestroyed.Y_distrib - ~EventKapitalDestroyed.Z_distrib ~EventKapitalDestroyed.aff_industries ~EventKapitalDestroyed.aff_regions - ~EventKapitalDestroyed.aff_regions_idx ~EventKapitalDestroyed.aff_sectors - ~EventKapitalDestroyed.aff_sectors_idx ~EventKapitalDestroyed.duration - ~EventKapitalDestroyed.gva_df - ~EventKapitalDestroyed.impact_df + ~EventKapitalDestroyed.impact + ~EventKapitalDestroyed.impact_households ~EventKapitalDestroyed.impact_industries_distrib ~EventKapitalDestroyed.impact_regional_distrib - ~EventKapitalDestroyed.model_monetary_factor - ~EventKapitalDestroyed.mrio_name ~EventKapitalDestroyed.occurrence - ~EventKapitalDestroyed.possible_final_demand_cat - ~EventKapitalDestroyed.possible_regions - ~EventKapitalDestroyed.possible_sectors - ~EventKapitalDestroyed.regional_sectoral_productive_capital_destroyed - ~EventKapitalDestroyed.regions_idx - ~EventKapitalDestroyed.sectors_gva_shares - ~EventKapitalDestroyed.sectors_idx - ~EventKapitalDestroyed.temporal_unit_range - ~EventKapitalDestroyed.x_shape - ~EventKapitalDestroyed.y_shape - ~EventKapitalDestroyed.z_shape ~EventKapitalDestroyed.event_monetary_factor - ~EventKapitalDestroyed.households_impact_df ~EventKapitalDestroyed.name - ~EventKapitalDestroyed.happened - ~EventKapitalDestroyed.over ~EventKapitalDestroyed.event_dict diff --git a/docs/source/_autosummary/boario.event.EventKapitalRebuild.rst b/docs/source/_autosummary/boario.event.EventKapitalRebuild.rst index 729f6be..2a1ef6d 100644 --- a/docs/source/_autosummary/boario.event.EventKapitalRebuild.rst +++ b/docs/source/_autosummary/boario.event.EventKapitalRebuild.rst @@ -16,12 +16,8 @@ EventKapitalRebuild .. autosummary:: ~EventKapitalRebuild.__init__ - ~EventKapitalRebuild.distribute_impact_by_gva - ~EventKapitalRebuild.distribute_impact_equally - ~EventKapitalRebuild.from_dataframe - ~EventKapitalRebuild.from_scalar_industries + ~EventKapitalRebuild.distribute_impact_industries ~EventKapitalRebuild.from_scalar_regions_sectors - ~EventKapitalRebuild.from_series @@ -31,41 +27,17 @@ EventKapitalRebuild .. autosummary:: - ~EventKapitalRebuild.Y_distrib - ~EventKapitalRebuild.Z_distrib ~EventKapitalRebuild.aff_industries ~EventKapitalRebuild.aff_regions - ~EventKapitalRebuild.aff_regions_idx ~EventKapitalRebuild.aff_sectors - ~EventKapitalRebuild.aff_sectors_idx ~EventKapitalRebuild.duration - ~EventKapitalRebuild.gva_df - ~EventKapitalRebuild.impact_df + ~EventKapitalRebuild.impact + ~EventKapitalRebuild.impact_households ~EventKapitalRebuild.impact_industries_distrib ~EventKapitalRebuild.impact_regional_distrib - ~EventKapitalRebuild.model_monetary_factor - ~EventKapitalRebuild.mrio_name ~EventKapitalRebuild.occurrence - ~EventKapitalRebuild.possible_final_demand_cat - ~EventKapitalRebuild.possible_regions - ~EventKapitalRebuild.possible_sectors - ~EventKapitalRebuild.rebuildable - ~EventKapitalRebuild.rebuilding_demand_house - ~EventKapitalRebuild.rebuilding_demand_indus + ~EventKapitalRebuild.rebuild_tau ~EventKapitalRebuild.rebuilding_sectors - ~EventKapitalRebuild.rebuilding_sectors_idx - ~EventKapitalRebuild.rebuilding_sectors_shares - ~EventKapitalRebuild.regional_sectoral_productive_capital_destroyed - ~EventKapitalRebuild.regions_idx - ~EventKapitalRebuild.sectors_gva_shares - ~EventKapitalRebuild.sectors_idx - ~EventKapitalRebuild.temporal_unit_range - ~EventKapitalRebuild.x_shape - ~EventKapitalRebuild.y_shape - ~EventKapitalRebuild.z_shape ~EventKapitalRebuild.event_monetary_factor - ~EventKapitalRebuild.households_impact_df ~EventKapitalRebuild.name - ~EventKapitalRebuild.happened - ~EventKapitalRebuild.over ~EventKapitalRebuild.event_dict diff --git a/docs/source/_autosummary/boario.event.EventKapitalRecover.rst b/docs/source/_autosummary/boario.event.EventKapitalRecover.rst index a32f70b..69313c1 100644 --- a/docs/source/_autosummary/boario.event.EventKapitalRecover.rst +++ b/docs/source/_autosummary/boario.event.EventKapitalRecover.rst @@ -16,13 +16,8 @@ EventKapitalRecover .. autosummary:: ~EventKapitalRecover.__init__ - ~EventKapitalRecover.distribute_impact_by_gva - ~EventKapitalRecover.distribute_impact_equally - ~EventKapitalRecover.from_dataframe - ~EventKapitalRecover.from_scalar_industries + ~EventKapitalRecover.distribute_impact_industries ~EventKapitalRecover.from_scalar_regions_sectors - ~EventKapitalRecover.from_series - ~EventKapitalRecover.recovery @@ -32,37 +27,17 @@ EventKapitalRecover .. autosummary:: - ~EventKapitalRecover.Y_distrib - ~EventKapitalRecover.Z_distrib ~EventKapitalRecover.aff_industries ~EventKapitalRecover.aff_regions - ~EventKapitalRecover.aff_regions_idx ~EventKapitalRecover.aff_sectors - ~EventKapitalRecover.aff_sectors_idx ~EventKapitalRecover.duration - ~EventKapitalRecover.gva_df - ~EventKapitalRecover.impact_df + ~EventKapitalRecover.impact + ~EventKapitalRecover.impact_households ~EventKapitalRecover.impact_industries_distrib ~EventKapitalRecover.impact_regional_distrib - ~EventKapitalRecover.model_monetary_factor - ~EventKapitalRecover.mrio_name ~EventKapitalRecover.occurrence - ~EventKapitalRecover.possible_final_demand_cat - ~EventKapitalRecover.possible_regions - ~EventKapitalRecover.possible_sectors - ~EventKapitalRecover.recoverable ~EventKapitalRecover.recovery_function - ~EventKapitalRecover.regional_sectoral_productive_capital_destroyed - ~EventKapitalRecover.regions_idx - ~EventKapitalRecover.sectors_gva_shares - ~EventKapitalRecover.sectors_idx - ~EventKapitalRecover.temporal_unit_range - ~EventKapitalRecover.x_shape - ~EventKapitalRecover.y_shape - ~EventKapitalRecover.z_shape + ~EventKapitalRecover.recovery_tau ~EventKapitalRecover.event_monetary_factor - ~EventKapitalRecover.households_impact_df ~EventKapitalRecover.name - ~EventKapitalRecover.happened - ~EventKapitalRecover.over ~EventKapitalRecover.event_dict diff --git a/docs/source/_autosummary/boario.event.rst b/docs/source/_autosummary/boario.event.rst index 040b73c..7883403 100644 --- a/docs/source/_autosummary/boario.event.rst +++ b/docs/source/_autosummary/boario.event.rst @@ -9,6 +9,14 @@ event + .. rubric:: Functions + + .. autosummary:: + + from_scalar_industries + from_scalar_regions_sectors + from_series + diff --git a/docs/source/_autosummary/boario.extended_models.ARIOPsiModel.rst b/docs/source/_autosummary/boario.extended_models.ARIOPsiModel.rst index 7101711..a9f71e8 100644 --- a/docs/source/_autosummary/boario.extended_models.ARIOPsiModel.rst +++ b/docs/source/_autosummary/boario.extended_models.ARIOPsiModel.rst @@ -23,8 +23,10 @@ ARIOPsiModel ~ARIOPsiModel.calc_production ~ARIOPsiModel.change_inv_duration ~ARIOPsiModel.distribute_production + ~ARIOPsiModel.rebuild_prod_house_event + ~ARIOPsiModel.rebuild_prod_indus_event ~ARIOPsiModel.reset_module - ~ARIOPsiModel.update_system_from_events + ~ARIOPsiModel.update_prod_delta ~ARIOPsiModel.write_index @@ -35,10 +37,12 @@ ARIOPsiModel .. autosummary:: - ~ARIOPsiModel.house_rebuild_demand - ~ARIOPsiModel.house_rebuild_demand_tot - ~ARIOPsiModel.indus_rebuild_demand - ~ARIOPsiModel.indus_rebuild_demand_tot + ~ARIOPsiModel.entire_demand + ~ARIOPsiModel.entire_demand_tot + ~ARIOPsiModel.final_demand + ~ARIOPsiModel.final_demand_tot + ~ARIOPsiModel.intermediate_demand + ~ARIOPsiModel.intermediate_demand_tot ~ARIOPsiModel.inventory_constraints_act ~ARIOPsiModel.inventory_constraints_opt ~ARIOPsiModel.prod_cap_delta_arbitrary @@ -47,26 +51,24 @@ ARIOPsiModel ~ARIOPsiModel.production_cap ~ARIOPsiModel.production_opt ~ARIOPsiModel.productive_capital_lost - ~ARIOPsiModel.tot_rebuild_demand - ~ARIOPsiModel.total_demand + ~ARIOPsiModel.rebuild_demand + ~ARIOPsiModel.rebuild_demand_house + ~ARIOPsiModel.rebuild_demand_house_tot + ~ARIOPsiModel.rebuild_demand_indus + ~ARIOPsiModel.rebuild_demand_indus_tot + ~ARIOPsiModel.rebuild_demand_tot + ~ARIOPsiModel.rebuild_prod + ~ARIOPsiModel.rebuild_prod_house + ~ARIOPsiModel.rebuild_prod_indus + ~ARIOPsiModel.rebuild_prod_tot ~ARIOPsiModel.psi ~ARIOPsiModel.restoration_tau - ~ARIOPsiModel.main_inv_dur - ~ARIOPsiModel.regions - ~ARIOPsiModel.n_regions - ~ARIOPsiModel.sectors - ~ARIOPsiModel.n_sectors - ~ARIOPsiModel.industries - ~ARIOPsiModel.n_industries - ~ARIOPsiModel.final_demand_cat - ~ARIOPsiModel.n_fd_cat ~ARIOPsiModel.n_temporal_units_by_step ~ARIOPsiModel.iotable_year_to_temporal_unit_factor ~ARIOPsiModel.rebuild_tau ~ARIOPsiModel.overprod_max ~ARIOPsiModel.overprod_tau ~ARIOPsiModel.overprod_base - ~ARIOPsiModel.inventories ~ARIOPsiModel.Z_0 ~ARIOPsiModel.Z_C ~ARIOPsiModel.Z_distrib @@ -74,17 +76,14 @@ ARIOPsiModel ~ARIOPsiModel.Y_distrib ~ARIOPsiModel.Y_0 ~ARIOPsiModel.X_0 - ~ARIOPsiModel.gdp_df + ~ARIOPsiModel.gva_df ~ARIOPsiModel.VA_0 ~ARIOPsiModel.tech_mat - ~ARIOPsiModel.k_stock - ~ARIOPsiModel.gdp_share_sector - ~ARIOPsiModel.matrix_share_thresh + ~ARIOPsiModel.productive_capital + ~ARIOPsiModel.threshold_not_input ~ARIOPsiModel.overprod - ~ARIOPsiModel.matrix_stock - ~ARIOPsiModel.matrix_orders + ~ARIOPsiModel.inputs_stock ~ARIOPsiModel.production ~ARIOPsiModel.in_shortage ~ARIOPsiModel.had_shortage - ~ARIOPsiModel.rebuild_prod ~ARIOPsiModel.final_demand_not_met diff --git a/docs/source/_autosummary/boario.model_base.ARIOBaseModel.rst b/docs/source/_autosummary/boario.model_base.ARIOBaseModel.rst index 1c10899..e21c044 100644 --- a/docs/source/_autosummary/boario.model_base.ARIOBaseModel.rst +++ b/docs/source/_autosummary/boario.model_base.ARIOBaseModel.rst @@ -23,8 +23,10 @@ ARIOBaseModel ~ARIOBaseModel.calc_production ~ARIOBaseModel.change_inv_duration ~ARIOBaseModel.distribute_production + ~ARIOBaseModel.rebuild_prod_house_event + ~ARIOBaseModel.rebuild_prod_indus_event ~ARIOBaseModel.reset_module - ~ARIOBaseModel.update_system_from_events + ~ARIOBaseModel.update_prod_delta ~ARIOBaseModel.write_index @@ -35,10 +37,12 @@ ARIOBaseModel .. autosummary:: - ~ARIOBaseModel.house_rebuild_demand - ~ARIOBaseModel.house_rebuild_demand_tot - ~ARIOBaseModel.indus_rebuild_demand - ~ARIOBaseModel.indus_rebuild_demand_tot + ~ARIOBaseModel.entire_demand + ~ARIOBaseModel.entire_demand_tot + ~ARIOBaseModel.final_demand + ~ARIOBaseModel.final_demand_tot + ~ARIOBaseModel.intermediate_demand + ~ARIOBaseModel.intermediate_demand_tot ~ARIOBaseModel.inventory_constraints_act ~ARIOBaseModel.inventory_constraints_opt ~ARIOBaseModel.prod_cap_delta_arbitrary @@ -47,24 +51,22 @@ ARIOBaseModel ~ARIOBaseModel.production_cap ~ARIOBaseModel.production_opt ~ARIOBaseModel.productive_capital_lost - ~ARIOBaseModel.tot_rebuild_demand - ~ARIOBaseModel.total_demand - ~ARIOBaseModel.main_inv_dur - ~ARIOBaseModel.regions - ~ARIOBaseModel.n_regions - ~ARIOBaseModel.sectors - ~ARIOBaseModel.n_sectors - ~ARIOBaseModel.industries - ~ARIOBaseModel.n_industries - ~ARIOBaseModel.final_demand_cat - ~ARIOBaseModel.n_fd_cat + ~ARIOBaseModel.rebuild_demand + ~ARIOBaseModel.rebuild_demand_house + ~ARIOBaseModel.rebuild_demand_house_tot + ~ARIOBaseModel.rebuild_demand_indus + ~ARIOBaseModel.rebuild_demand_indus_tot + ~ARIOBaseModel.rebuild_demand_tot + ~ARIOBaseModel.rebuild_prod + ~ARIOBaseModel.rebuild_prod_house + ~ARIOBaseModel.rebuild_prod_indus + ~ARIOBaseModel.rebuild_prod_tot ~ARIOBaseModel.n_temporal_units_by_step ~ARIOBaseModel.iotable_year_to_temporal_unit_factor ~ARIOBaseModel.rebuild_tau ~ARIOBaseModel.overprod_max ~ARIOBaseModel.overprod_tau ~ARIOBaseModel.overprod_base - ~ARIOBaseModel.inventories ~ARIOBaseModel.Z_0 ~ARIOBaseModel.Z_C ~ARIOBaseModel.Z_distrib @@ -72,17 +74,14 @@ ARIOBaseModel ~ARIOBaseModel.Y_distrib ~ARIOBaseModel.Y_0 ~ARIOBaseModel.X_0 - ~ARIOBaseModel.gdp_df + ~ARIOBaseModel.gva_df ~ARIOBaseModel.VA_0 ~ARIOBaseModel.tech_mat - ~ARIOBaseModel.k_stock - ~ARIOBaseModel.gdp_share_sector - ~ARIOBaseModel.matrix_share_thresh + ~ARIOBaseModel.productive_capital + ~ARIOBaseModel.threshold_not_input ~ARIOBaseModel.overprod - ~ARIOBaseModel.matrix_stock - ~ARIOBaseModel.matrix_orders + ~ARIOBaseModel.inputs_stock ~ARIOBaseModel.production ~ARIOBaseModel.in_shortage ~ARIOBaseModel.had_shortage - ~ARIOBaseModel.rebuild_prod ~ARIOBaseModel.final_demand_not_met diff --git a/docs/source/_autosummary/boario.rst b/docs/source/_autosummary/boario.rst index d0fba93..2b4ad6c 100644 --- a/docs/source/_autosummary/boario.rst +++ b/docs/source/_autosummary/boario.rst @@ -10,6 +10,7 @@ .. autosummary:: DEBUGFORMATTER + INFOFORMATTER @@ -19,6 +20,10 @@ .. autosummary:: + activate_logging + deactivate_logging + disable_console_logging + enable_console_logging warn_once diff --git a/docs/source/_autosummary/boario.simulation.Simulation.rst b/docs/source/_autosummary/boario.simulation.Simulation.rst index 706cb02..60bb2a6 100644 --- a/docs/source/_autosummary/boario.simulation.Simulation.rst +++ b/docs/source/_autosummary/boario.simulation.Simulation.rst @@ -19,10 +19,19 @@ Simulation ~Simulation.add_event ~Simulation.add_events ~Simulation.check_equilibrium + ~Simulation.event_compatibility ~Simulation.loop ~Simulation.next_step + ~Simulation.rebuild_events + ~Simulation.recover_events + ~Simulation.regions_compatible ~Simulation.reset_sim_full ~Simulation.reset_sim_with_same_events + ~Simulation.sectors_compatible + ~Simulation.update_prod_cap_delta_arb + ~Simulation.update_prod_cap_delta_tot + ~Simulation.update_productive_capital_lost + ~Simulation.update_rebuild_demand ~Simulation.write_index @@ -48,7 +57,6 @@ Simulation ~Simulation.results_storage ~Simulation.model ~Simulation.all_events - ~Simulation.currently_happening_events ~Simulation.n_temporal_units_to_sim ~Simulation.current_temporal_unit ~Simulation.records_storage diff --git a/docs/source/_autosummary/boario.simulation.rst b/docs/source/_autosummary/boario.simulation.rst index 384ce13..f977a93 100644 --- a/docs/source/_autosummary/boario.simulation.rst +++ b/docs/source/_autosummary/boario.simulation.rst @@ -19,4 +19,5 @@ simulation :toctree: :template: custom-class-template.rst + EventTracker Simulation