py_champ package

Subpackages

• py_champ.components package
  • Submodules
  • py_champ.components.aquifer module
    • Aquifer
      • Aquifer.agt_type
      • Aquifer.st
      • Aquifer.dwl_list
      • Aquifer.dwl
      • Aquifer.t
      • Aquifer.withdrawal
      • Aquifer.load_settings()
      • Aquifer.step()
  • py_champ.components.behavior module
    • Behavior
      • Behavior.agt_type
      • Behavior.num_fields
      • Behavior.num_wells
      • Behavior.total_field_area
      • Behavior.t
      • Behavior.state
      • Behavior.load_settings()
      • Behavior.process_percieved_risks()
      • Behavior.update_perceived_prec_aw()
      • Behavior.step()
      • Behavior.run_simulation()
      • Behavior.make_dm()
      • Behavior.make_dm_deliberation()
      • Behavior.make_dm_repetition()
      • Behavior.make_dm_social_comparison()
      • Behavior.make_dm_imitation()
    • Behavior4SingleFieldAndWell
      • Behavior4SingleFieldAndWell.load_settings()
      • Behavior4SingleFieldAndWell.process_percieved_risks()
      • Behavior4SingleFieldAndWell.update_perceived_prec_aw()
      • Behavior4SingleFieldAndWell.step()
      • Behavior4SingleFieldAndWell.run_simulation()
      • Behavior4SingleFieldAndWell.make_dm()
      • Behavior4SingleFieldAndWell.make_dm_deliberation()
      • Behavior4SingleFieldAndWell.make_dm_repetition()
      • Behavior4SingleFieldAndWell.make_dm_social_comparison()
      • Behavior4SingleFieldAndWell.make_dm_imitation()
    • Behavior4SingleFieldAndWell_simCJ
      • Behavior4SingleFieldAndWell_simCJ.load_settings()
      • Behavior4SingleFieldAndWell_simCJ.process_percieved_risks()
      • Behavior4SingleFieldAndWell_simCJ.update_perceived_prec_aw()
      • Behavior4SingleFieldAndWell_simCJ.step()
      • Behavior4SingleFieldAndWell_simCJ.run_simulation()
      • Behavior4SingleFieldAndWell_simCJ.make_dm()
      • Behavior4SingleFieldAndWell_simCJ.make_dm_deliberation()
      • Behavior4SingleFieldAndWell_simCJ.make_dm_repetition()
      • Behavior4SingleFieldAndWell_simCJ.make_dm_social_comparison()
      • Behavior4SingleFieldAndWell_simCJ.make_dm_imitation()
    • Behavior4SingleFieldAndWell_ogCJ
      • Behavior4SingleFieldAndWell_ogCJ.load_settings()
      • Behavior4SingleFieldAndWell_ogCJ.process_percieved_risks()
      • Behavior4SingleFieldAndWell_ogCJ.update_perceived_prec_aw()
      • Behavior4SingleFieldAndWell_ogCJ.step()
      • Behavior4SingleFieldAndWell_ogCJ.run_simulation()
      • Behavior4SingleFieldAndWell_ogCJ.make_dm()
      • Behavior4SingleFieldAndWell_ogCJ.make_dm_deliberation()
      • Behavior4SingleFieldAndWell_ogCJ.make_dm_repetition()
      • Behavior4SingleFieldAndWell_ogCJ.make_dm_social_comparison()
      • Behavior4SingleFieldAndWell_ogCJ.make_dm_imitation()
    • Behavior_1f1w_ci
      • Behavior_1f1w_ci.agt_type
      • Behavior_1f1w_ci.num_fields
      • Behavior_1f1w_ci.num_wells
      • Behavior_1f1w_ci.total_field_area
      • Behavior_1f1w_ci.t
      • Behavior_1f1w_ci.state
      • Behavior_1f1w_ci.load_settings()
      • Behavior_1f1w_ci.process_percieved_risks()
      • Behavior_1f1w_ci.update_perceived_prec_aw()
      • Behavior_1f1w_ci.step()
      • Behavior_1f1w_ci.run_simulation()
      • Behavior_1f1w_ci.make_dm()
      • Behavior_1f1w_ci.make_dm_deliberation()
      • Behavior_1f1w_ci.make_dm_repetition()
      • Behavior_1f1w_ci.make_dm_social_comparison()
      • Behavior_1f1w_ci.make_dm_imitation()
  • py_champ.components.field module
    • Field
      • Field.agt_type
      • Field.te
      • Field.crops
      • Field.field_type
      • Field.t
      • Field.irr_vol
      • Field.yield_rate_per_field
      • Field.irr_vol_per_field
      • Field.load_settings()
      • Field.update_irr_tech()
      • Field.update_crops()
      • Field.step()
    • Field4SingleFieldAndWell
      • Field4SingleFieldAndWell.load_settings()
      • Field4SingleFieldAndWell.update_crops()
      • Field4SingleFieldAndWell.step()
    • Field_1f1w_ci
      • Field_1f1w_ci.load_settings()
      • Field_1f1w_ci.update_crops()
      • Field_1f1w_ci.update_aph_yield()
      • Field_1f1w_ci.step()
  • py_champ.components.finance module
    • Finance
      • Finance.agt_type
      • Finance.profit
      • Finance.y
      • Finance.t
      • Finance.load_settings()
      • Finance.step()
    • Finance4SingleFieldAndWell
      • Finance4SingleFieldAndWell.load_settings()
      • Finance4SingleFieldAndWell.step()
    • Finance_1f1w_ci
      • Finance_1f1w_ci.agt_type
      • Finance_1f1w_ci.profit
      • Finance_1f1w_ci.y
      • Finance_1f1w_ci.t
      • Finance_1f1w_ci.load_settings()
      • Finance_1f1w_ci.cal_APH_revenue_based_premium()
      • Finance_1f1w_ci.cal_APH_revenue_based_payout()
      • Finance_1f1w_ci.step()
  • py_champ.components.optimization module
    • Optimization
      • Optimization.name
      • Optimization.depose_gp_env()
      • Optimization.setup_ini_model()
      • Optimization.setup_constr_field()
      • Optimization.setup_constr_well()
      • Optimization.setup_constr_finance()
      • Optimization.setup_constr_wr()
      • Optimization.setup_obj()
      • Optimization.finish_setup()
      • Optimization.solve()
      • Optimization.do_IIS_gp()
      • Optimization.write_ilp()
      • Optimization.write_sol()
      • Optimization.write_lp()
      • Optimization.write_mps()
    • dict_to_string()
  • py_champ.components.optimization_1f1w module
    • Optimization4SingleFieldAndWell
      • Optimization4SingleFieldAndWell.setup_ini_model()
      • Optimization4SingleFieldAndWell.setup_constr_field()
      • Optimization4SingleFieldAndWell.setup_constr_well()
      • Optimization4SingleFieldAndWell.setup_constr_finance()
      • Optimization4SingleFieldAndWell.setup_constr_wr()
      • Optimization4SingleFieldAndWell.setup_obj()
      • Optimization4SingleFieldAndWell.finish_setup()
      • Optimization4SingleFieldAndWell.solve()
      • Optimization4SingleFieldAndWell.do_IIS_gp()
      • Optimization4SingleFieldAndWell.write_file()
    • Optimization4SingleFieldAndWell_simCJ
      • Optimization4SingleFieldAndWell_simCJ.setup_ini_model()
      • Optimization4SingleFieldAndWell_simCJ.setup_constr_field()
      • Optimization4SingleFieldAndWell_simCJ.setup_constr_well()
      • Optimization4SingleFieldAndWell_simCJ.setup_constr_finance()
      • Optimization4SingleFieldAndWell_simCJ.setup_constr_wr()
      • Optimization4SingleFieldAndWell_simCJ.setup_obj()
      • Optimization4SingleFieldAndWell_simCJ.finish_setup()
      • Optimization4SingleFieldAndWell_simCJ.solve()
      • Optimization4SingleFieldAndWell_simCJ.do_IIS_gp()
      • Optimization4SingleFieldAndWell_simCJ.write_file()
    • Optimization4SingleFieldAndWell_ogCJ
      • Optimization4SingleFieldAndWell_ogCJ.setup_ini_model()
      • Optimization4SingleFieldAndWell_ogCJ.setup_constr_field()
      • Optimization4SingleFieldAndWell_ogCJ.setup_constr_well()
      • Optimization4SingleFieldAndWell_ogCJ.setup_constr_finance()
      • Optimization4SingleFieldAndWell_ogCJ.setup_constr_wr()
      • Optimization4SingleFieldAndWell_ogCJ.setup_obj()
      • Optimization4SingleFieldAndWell_ogCJ.finish_setup()
      • Optimization4SingleFieldAndWell_ogCJ.solve()
      • Optimization4SingleFieldAndWell_ogCJ.do_IIS_gp()
      • Optimization4SingleFieldAndWell_ogCJ.write_file()
  • py_champ.components.optimization_1f1w_ci module
    • Optimization_1f1w_ci
      • Optimization_1f1w_ci.setup_ini_model()
      • Optimization_1f1w_ci.setup_constr_field()
      • Optimization_1f1w_ci.setup_constr_well()
      • Optimization_1f1w_ci.setup_constr_finance()
      • Optimization_1f1w_ci.setup_constr_wr()
      • Optimization_1f1w_ci.setup_obj()
      • Optimization_1f1w_ci.finish_setup()
      • Optimization_1f1w_ci.solve()
      • Optimization_1f1w_ci.do_IIS_gp()
      • Optimization_1f1w_ci.write_ilp()
      • Optimization_1f1w_ci.write_sol()
      • Optimization_1f1w_ci.write_lp()
      • Optimization_1f1w_ci.write_mps()
      • Optimization_1f1w_ci.depose_gp_env()
    • dict_to_string()
  • py_champ.components.well module
    • Well
      • Well.agt_type
      • Well.st
      • Well.l_wt
      • Well.pumping_days
      • Well.tr
      • Well.t
      • Well.e
      • Well.withdrawal
      • Well.load_settings()
      • Well.step()
    • Well4SingleFieldAndWell
      • Well4SingleFieldAndWell.load_settings()
      • Well4SingleFieldAndWell.step()
    • Well4SingleFieldAndWell_simCJ
      • Well4SingleFieldAndWell_simCJ.load_settings()
      • Well4SingleFieldAndWell_simCJ.step()
    • Well4SingleFieldAndWell_ogCJ
      • Well4SingleFieldAndWell_ogCJ.load_settings()
      • Well4SingleFieldAndWell_ogCJ.step()
  • Module contents
• py_champ.models package
  • Submodules
  • py_champ.models.particle_swarm module
    • GlobalBestPSO
      • GlobalBestPSO.to_dict()
      • GlobalBestPSO.optimize()
  • py_champ.models.sd6_model module
    • SD6Model
      • SD6Model.schedule
      • SD6Model.datacollector
      • SD6Model.step()
      • SD6Model.end()
      • SD6Model.get_dfs()
      • SD6Model.get_df_sys()
      • SD6Model.get_metrices()
    • SD6Model_input_templates
  • py_champ.models.sd6_model_1f1w module
    • SD6Model4SingleFieldAndWell
      • SD6Model4SingleFieldAndWell.step()
      • SD6Model4SingleFieldAndWell.end()
      • SD6Model4SingleFieldAndWell.get_dfs()
      • SD6Model4SingleFieldAndWell.get_metrices()
  • py_champ.models.sd6_model_1f1w_ci module
    • SD6Model_1f1w_ci
      • SD6Model_1f1w_ci.schedule
      • SD6Model_1f1w_ci.datacollector
      • SD6Model_1f1w_ci.step()
      • SD6Model_1f1w_ci.end()
      • SD6Model_1f1w_ci.get_datacollector_output()
      • SD6Model_1f1w_ci.get_dfs()
      • SD6Model_1f1w_ci.get_metrices()
  • Module contents
• py_champ.utility package
  • Submodules
  • py_champ.utility.util module
    • BaseSchedulerByTypeFiltered
      • BaseSchedulerByTypeFiltered.step()
      • BaseSchedulerByTypeFiltered.do_each()
    • get_nested_attr()
    • get_agt_attr()
    • dict_to_string()
    • TimeRecorder
      • TimeRecorder.get_elapsed_time()
      • TimeRecorder.sec2str()
    • Indicator
      • Indicator.remove_na()
      • Indicator.cal_indicator_df()
      • Indicator.get_r()
      • Indicator.get_r2()
      • Indicator.get_rmse()
      • Indicator.get_nse()
      • Indicator.get_inse()
      • Indicator.get_cp()
      • Indicator.get_rsr()
      • Indicator.get_kge()
      • Indicator.get_ikge()
  • Module contents

Module contents

Provides the core functionality for the PyCHAMP package.