PyCHAMP
1.0.0
User Guide
Installation Steps
Introduction to the PyCHAMP Package
Model Examples
PyCHAMP
PyCHAMP
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
Y
A
agt_type (py_champ.components.aquifer.Aquifer attribute)
(py_champ.components.behavior.Behavior attribute)
(py_champ.components.behavior.Behavior_1f1w_ci attribute)
(py_champ.components.field.Field attribute)
(py_champ.components.finance.Finance attribute)
(py_champ.components.finance.Finance_1f1w_ci attribute)
(py_champ.components.well.Well attribute)
Aquifer (class in py_champ.components.aquifer)
B
BaseSchedulerByTypeFiltered (class in py_champ.utility.util)
Behavior (class in py_champ.components.behavior)
Behavior4SingleFieldAndWell (class in py_champ.components.behavior)
Behavior4SingleFieldAndWell_ogCJ (class in py_champ.components.behavior)
Behavior4SingleFieldAndWell_simCJ (class in py_champ.components.behavior)
Behavior_1f1w_ci (class in py_champ.components.behavior)
C
cal_APH_revenue_based_payout() (py_champ.components.finance.Finance_1f1w_ci method)
cal_APH_revenue_based_premium() (py_champ.components.finance.Finance_1f1w_ci static method)
cal_indicator_df() (py_champ.utility.util.Indicator static method)
crops (py_champ.components.field.Field attribute)
D
datacollector (py_champ.models.sd6_model.SD6Model attribute)
(py_champ.models.sd6_model_1f1w_ci.SD6Model_1f1w_ci attribute)
depose_gp_env() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
dict_to_string() (in module py_champ.components.optimization)
(in module py_champ.components.optimization_1f1w_ci)
(in module py_champ.utility.util)
do_each() (py_champ.utility.util.BaseSchedulerByTypeFiltered method)
do_IIS_gp() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
dwl (py_champ.components.aquifer.Aquifer attribute)
dwl_list (py_champ.components.aquifer.Aquifer attribute)
E
e (py_champ.components.well.Well attribute)
end() (py_champ.models.sd6_model.SD6Model method)
(py_champ.models.sd6_model_1f1w.SD6Model4SingleFieldAndWell method)
(py_champ.models.sd6_model_1f1w_ci.SD6Model_1f1w_ci method)
F
Field (class in py_champ.components.field)
Field4SingleFieldAndWell (class in py_champ.components.field)
Field_1f1w_ci (class in py_champ.components.field)
field_type (py_champ.components.field.Field attribute)
Finance (class in py_champ.components.finance)
Finance4SingleFieldAndWell (class in py_champ.components.finance)
Finance_1f1w_ci (class in py_champ.components.finance)
finish_setup() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
G
get_agt_attr() (in module py_champ.utility.util)
get_cp() (py_champ.utility.util.Indicator static method)
get_datacollector_output() (py_champ.models.sd6_model_1f1w_ci.SD6Model_1f1w_ci method)
get_df_sys() (py_champ.models.sd6_model.SD6Model static method)
get_dfs() (py_champ.models.sd6_model.SD6Model static method)
(py_champ.models.sd6_model_1f1w.SD6Model4SingleFieldAndWell static method)
(py_champ.models.sd6_model_1f1w_ci.SD6Model_1f1w_ci static method)
get_elapsed_time() (py_champ.utility.util.TimeRecorder method)
get_ikge() (py_champ.utility.util.Indicator static method)
get_inse() (py_champ.utility.util.Indicator static method)
get_kge() (py_champ.utility.util.Indicator static method)
get_metrices() (py_champ.models.sd6_model.SD6Model static method)
(py_champ.models.sd6_model_1f1w.SD6Model4SingleFieldAndWell static method)
(py_champ.models.sd6_model_1f1w_ci.SD6Model_1f1w_ci static method)
get_nested_attr() (in module py_champ.utility.util)
get_nse() (py_champ.utility.util.Indicator static method)
get_r() (py_champ.utility.util.Indicator static method)
get_r2() (py_champ.utility.util.Indicator static method)
get_rmse() (py_champ.utility.util.Indicator static method)
get_rsr() (py_champ.utility.util.Indicator static method)
GlobalBestPSO (class in py_champ.models.particle_swarm)
I
Indicator (class in py_champ.utility.util)
irr_vol (py_champ.components.field.Field attribute)
irr_vol_per_field (py_champ.components.field.Field attribute)
L
l_wt (py_champ.components.well.Well attribute)
load_settings() (py_champ.components.aquifer.Aquifer method)
(py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
(py_champ.components.field.Field method)
(py_champ.components.field.Field4SingleFieldAndWell method)
(py_champ.components.field.Field_1f1w_ci method)
(py_champ.components.finance.Finance method)
(py_champ.components.finance.Finance4SingleFieldAndWell method)
(py_champ.components.finance.Finance_1f1w_ci method)
(py_champ.components.well.Well method)
(py_champ.components.well.Well4SingleFieldAndWell method)
(py_champ.components.well.Well4SingleFieldAndWell_ogCJ method)
(py_champ.components.well.Well4SingleFieldAndWell_simCJ method)
M
make_dm() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
make_dm_deliberation() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
make_dm_imitation() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
make_dm_repetition() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
make_dm_social_comparison() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
module
py_champ
py_champ.components
py_champ.components.aquifer
,
[1]
py_champ.components.behavior
,
[1]
py_champ.components.field
,
[1]
py_champ.components.finance
,
[1]
py_champ.components.optimization
,
[1]
py_champ.components.optimization_1f1w
py_champ.components.optimization_1f1w_ci
py_champ.components.well
,
[1]
py_champ.models
py_champ.models.particle_swarm
py_champ.models.sd6_model
py_champ.models.sd6_model_1f1w
py_champ.models.sd6_model_1f1w_ci
py_champ.utility
py_champ.utility.util
N
name (py_champ.components.optimization.Optimization attribute)
num_fields (py_champ.components.behavior.Behavior attribute)
(py_champ.components.behavior.Behavior_1f1w_ci attribute)
num_wells (py_champ.components.behavior.Behavior attribute)
(py_champ.components.behavior.Behavior_1f1w_ci attribute)
O
Optimization (class in py_champ.components.optimization)
Optimization4SingleFieldAndWell (class in py_champ.components.optimization_1f1w)
Optimization4SingleFieldAndWell_ogCJ (class in py_champ.components.optimization_1f1w)
Optimization4SingleFieldAndWell_simCJ (class in py_champ.components.optimization_1f1w)
Optimization_1f1w_ci (class in py_champ.components.optimization_1f1w_ci)
optimize() (py_champ.models.particle_swarm.GlobalBestPSO method)
P
process_percieved_risks() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
profit (py_champ.components.finance.Finance attribute)
(py_champ.components.finance.Finance_1f1w_ci attribute)
pumping_days (py_champ.components.well.Well attribute)
py_champ
module
py_champ.components
module
py_champ.components.aquifer
module
,
[1]
py_champ.components.behavior
module
,
[1]
py_champ.components.field
module
,
[1]
py_champ.components.finance
module
,
[1]
py_champ.components.optimization
module
,
[1]
py_champ.components.optimization_1f1w
module
py_champ.components.optimization_1f1w_ci
module
py_champ.components.well
module
,
[1]
py_champ.models
module
py_champ.models.particle_swarm
module
py_champ.models.sd6_model
module
py_champ.models.sd6_model_1f1w
module
py_champ.models.sd6_model_1f1w_ci
module
py_champ.utility
module
py_champ.utility.util
module
R
remove_na() (py_champ.utility.util.Indicator static method)
run_simulation() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
S
schedule (py_champ.models.sd6_model.SD6Model attribute)
(py_champ.models.sd6_model_1f1w_ci.SD6Model_1f1w_ci attribute)
SD6Model (class in py_champ.models.sd6_model)
SD6Model4SingleFieldAndWell (class in py_champ.models.sd6_model_1f1w)
SD6Model_1f1w_ci (class in py_champ.models.sd6_model_1f1w_ci)
SD6Model_input_templates (class in py_champ.models.sd6_model)
sec2str() (py_champ.utility.util.TimeRecorder static method)
setup_constr_field() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
setup_constr_finance() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
setup_constr_well() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
setup_constr_wr() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
setup_ini_model() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
setup_obj() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
solve() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
st (py_champ.components.aquifer.Aquifer attribute)
(py_champ.components.well.Well attribute)
state (py_champ.components.behavior.Behavior attribute)
(py_champ.components.behavior.Behavior_1f1w_ci attribute)
step() (py_champ.components.aquifer.Aquifer method)
(py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
(py_champ.components.field.Field method)
(py_champ.components.field.Field4SingleFieldAndWell method)
(py_champ.components.field.Field_1f1w_ci method)
(py_champ.components.finance.Finance method)
(py_champ.components.finance.Finance4SingleFieldAndWell method)
(py_champ.components.finance.Finance_1f1w_ci method)
(py_champ.components.well.Well method)
(py_champ.components.well.Well4SingleFieldAndWell method)
(py_champ.components.well.Well4SingleFieldAndWell_ogCJ method)
(py_champ.components.well.Well4SingleFieldAndWell_simCJ method)
(py_champ.models.sd6_model.SD6Model method)
(py_champ.models.sd6_model_1f1w.SD6Model4SingleFieldAndWell method)
(py_champ.models.sd6_model_1f1w_ci.SD6Model_1f1w_ci method)
(py_champ.utility.util.BaseSchedulerByTypeFiltered method)
T
t (py_champ.components.aquifer.Aquifer attribute)
(py_champ.components.behavior.Behavior attribute)
(py_champ.components.behavior.Behavior_1f1w_ci attribute)
(py_champ.components.field.Field attribute)
(py_champ.components.finance.Finance attribute)
(py_champ.components.finance.Finance_1f1w_ci attribute)
(py_champ.components.well.Well attribute)
te (py_champ.components.field.Field attribute)
TimeRecorder (class in py_champ.utility.util)
to_dict() (py_champ.models.particle_swarm.GlobalBestPSO method)
total_field_area (py_champ.components.behavior.Behavior attribute)
(py_champ.components.behavior.Behavior_1f1w_ci attribute)
tr (py_champ.components.well.Well attribute)
U
update_aph_yield() (py_champ.components.field.Field_1f1w_ci method)
update_crops() (py_champ.components.field.Field method)
(py_champ.components.field.Field4SingleFieldAndWell method)
(py_champ.components.field.Field_1f1w_ci method)
update_irr_tech() (py_champ.components.field.Field method)
update_perceived_prec_aw() (py_champ.components.behavior.Behavior method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_ogCJ method)
(py_champ.components.behavior.Behavior4SingleFieldAndWell_simCJ method)
(py_champ.components.behavior.Behavior_1f1w_ci method)
W
Well (class in py_champ.components.well)
Well4SingleFieldAndWell (class in py_champ.components.well)
Well4SingleFieldAndWell_ogCJ (class in py_champ.components.well)
Well4SingleFieldAndWell_simCJ (class in py_champ.components.well)
withdrawal (py_champ.components.aquifer.Aquifer attribute)
(py_champ.components.well.Well attribute)
write_file() (py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_ogCJ method)
(py_champ.components.optimization_1f1w.Optimization4SingleFieldAndWell_simCJ method)
write_ilp() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
write_lp() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
write_mps() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
write_sol() (py_champ.components.optimization.Optimization method)
(py_champ.components.optimization_1f1w_ci.Optimization_1f1w_ci method)
Y
y (py_champ.components.finance.Finance attribute)
(py_champ.components.finance.Finance_1f1w_ci attribute)
yield_rate_per_field (py_champ.components.field.Field attribute)