boar
Getting started:
Installation
Additional necessary installs for the agents
Disclaimer
Scientific publications based on the BOAR project
Change Log
Model fitting examples:
BOAR with SIMsalabim
BOAR with SIMsalabim Organic Photovoltaic (OPV) example
BOAR for TAS fitting
Multi-Objective Fitting of TrPL and TrMC Data
Notebooks gallery
Optimization and DoE examples:
Design of Experiments to optimize perovskite solar cells efficiency
Multi-objective optimization for perovskite material composition
Custom evaluate function for Multi-Objective Optimization - Transfer Matrix example
Notebooks gallery
BOAR API:
boar
boar
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
A
Agent (class in boar.agents.Agent)
B
Bimolecular_Trapping_Detrapping_equation() (in module boar.dynamic_utils.rate_eq)
Bimolecular_Trapping_equation() (in module boar.dynamic_utils.rate_eq)
boar
module
boar.agents
module
boar.agents.Agent
module
boar.agents.DD_agents
module
boar.agents.NonIdealDiode_agents
module
boar.agents.TAS_agent
module
boar.agents.TranferMatrix_agent
module
boar.agents.TrMC_agent
module
boar.agents.TrPL_agent
module
boar.core
module
boar.core.FitParams
module
boar.core.funcs
module
boar.core.optimization
module
boar.core.optimization_botorch
module
boar.core.optimizer
module
boar.dynamic_utils
module
boar.dynamic_utils.pump
module
boar.dynamic_utils.rate_eq
module
boar.SIMsalabim_utils
module
boar.SIMsalabim_utils.aux_func
module
boar.SIMsalabim_utils.CalcFom
module
boar.SIMsalabim_utils.CleanFolder
module
boar.SIMsalabim_utils.CompileProg
module
boar.SIMsalabim_utils.Download_SIMsalabim
module
boar.SIMsalabim_utils.GetInputPar
module
boar.SIMsalabim_utils.MakeDevParFile
module
boar.SIMsalabim_utils.plot_settings_screen
module
boar.SIMsalabim_utils.PlotInputPar
module
boar.SIMsalabim_utils.RunSim
module
boar.SIMsalabim_utils.SimSS_plots
module
boar.SIMsalabim_utils.tVG_gen
module
boar.SIMsalabim_utils.ZimT_plots
module
BoarOptimizer (class in boar.core.optimizer)
BoTorchOpti() (boar.core.optimization_botorch.MooBOtorch method)
C
callable_name() (in module boar.core.funcs)
Check_fit_params() (boar.agents.DD_agents.Drift_diffusion_agent method)
CheckProgVersion() (in module boar.SIMsalabim_utils.MakeDevParFile)
ChosePar() (in module boar.SIMsalabim_utils.GetInputPar)
clean_file_type() (in module boar.SIMsalabim_utils.CleanFolder)
clean_up_output() (in module boar.SIMsalabim_utils.CleanFolder)
Compare_JVs_exp() (boar.agents.DD_agents.Drift_diffusion_agent method)
Compare_JVs_simu() (boar.agents.DD_agents.Drift_diffusion_agent method)
conduction_urbach() (in module boar.SIMsalabim_utils.aux_func)
ConvertParams() (boar.core.optimization_botorch.MooBOtorch method)
cost_from_old_xy() (boar.core.optimization.MultiObjectiveOptimizer method)
D
DegradationPrepareSimuInputs() (in module boar.SIMsalabim_utils.RunSim)
delta_B() (in module boar.SIMsalabim_utils.CalcFom)
delta_T() (in module boar.SIMsalabim_utils.CalcFom)
DifferentialIdealityFactor() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
DifferentialResistance() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
do_grid_posterior() (boar.core.optimization.MultiObjectiveOptimizer method)
(boar.core.optimization_botorch.MooBOtorch method)
double_urbach() (in module boar.SIMsalabim_utils.aux_func)
double_urbach_midgap() (in module boar.SIMsalabim_utils.aux_func)
download_simsalabim() (in module boar.SIMsalabim_utils.Download_SIMsalabim)
Drift_diffusion_agent (class in boar.agents.DD_agents)
DriftDiffusion() (boar.agents.DD_agents.Drift_diffusion_agent method)
DriftDiffusion4fit() (boar.agents.DD_agents.Drift_diffusion_agent method)
DriftDiffusion_rela_nrj_Trap_dist() (boar.agents.DD_agents.Drift_diffusion_agent method)
DriftDiffusion_relative() (boar.agents.DD_agents.Drift_diffusion_agent method)
E
evaluate() (boar.core.optimization_botorch.MooBOtorch method)
evaluate_custom() (boar.core.optimization_botorch.MooBOtorch method)
expected_minimum_BOAR() (boar.core.optimization_botorch.MooBOtorch method)
F
FitNonIdealDiode() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
Fitparam (class in boar.core.FitParams)
FOMparam (class in boar.core.FitParams)
format_func() (boar.core.optimizer.BoarOptimizer method)
fpc_prog() (in module boar.SIMsalabim_utils.CompileProg)
G
gauss() (in module boar.core.funcs)
gauss_sk() (in module boar.core.funcs)
gaussian_pulse() (in module boar.SIMsalabim_utils.tVG_gen)
gaussian_pulse_norm() (in module boar.core.funcs)
(in module boar.dynamic_utils.pump)
gaussian_pump() (in module boar.dynamic_utils.pump)
get_alpha_factor() (in module boar.SIMsalabim_utils.aux_func)
get_FF() (in module boar.SIMsalabim_utils.aux_func)
get_fitval() (boar.agents.Agent.Agent method)
get_flux_density() (in module boar.core.funcs)
(in module boar.dynamic_utils.pump)
get_FOM() (boar.agents.DD_agents.Drift_diffusion_agent method)
get_FOMs() (boar.agents.DD_agents.Drift_diffusion_agent method)
get_ideality_factor() (in module boar.SIMsalabim_utils.aux_func)
get_Jsc() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
(in module boar.SIMsalabim_utils.aux_func)
get_model() (boar.core.optimization_botorch.MooBOtorch method)
get_ntotal() (boar.agents.TranferMatrix_agent.Transfer_Matrix_agent method)
get_param_dict() (boar.agents.Agent.Agent method)
get_PCE() (in module boar.SIMsalabim_utils.aux_func)
get_pseudo_JV() (boar.agents.TAS_agent.TAS_agent method)
get_random_value() (in module boar.SIMsalabim_utils.aux_func)
get_Rseries() (in module boar.SIMsalabim_utils.CalcFom)
get_Rshunt() (in module boar.SIMsalabim_utils.CalcFom)
get_unique_X() (in module boar.core.funcs)
get_unique_X_and_xaxis_values() (in module boar.core.funcs)
get_Voc() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
(in module boar.SIMsalabim_utils.aux_func)
GetParFromStr() (in module boar.SIMsalabim_utils.GetInputPar)
I
I_mat() (boar.agents.TranferMatrix_agent.Transfer_Matrix_agent method)
init_args_flux_pump_models() (boar.agents.TAS_agent.TAS_agent method)
(boar.agents.TrMC_agent.TrMC_agent method)
(boar.agents.TrPL_agent.TrPL_agent method)
initial_carrier_density() (in module boar.dynamic_utils.pump)
invert_lossfunc() (boar.core.optimizer.BoarOptimizer method)
L
L_mat() (boar.agents.TranferMatrix_agent.Transfer_Matrix_agent method)
LH() (boar.core.optimization.MultiObjectiveOptimizer method)
LH_torch() (boar.core.optimization_botorch.MooBOtorch method)
LinearFunc() (in module boar.SIMsalabim_utils.aux_func)
LLH() (boar.core.optimization.MultiObjectiveOptimizer method)
load_old_xy() (boar.core.optimization.MultiObjectiveOptimizer method)
lossfunc() (boar.core.optimizer.BoarOptimizer method)
M
MakeDevParFileCopy() (in module boar.SIMsalabim_utils.MakeDevParFile)
makeobjectives() (boar.core.optimization_botorch.MooBOtorch method)
marginal_posterior_1D() (boar.core.optimization.MultiObjectiveOptimizer method)
(boar.core.optimization_botorch.MooBOtorch method)
marginal_posterior_2D() (boar.core.optimization.MultiObjectiveOptimizer method)
(boar.core.optimization_botorch.MooBOtorch method)
module
boar
boar.agents
boar.agents.Agent
boar.agents.DD_agents
boar.agents.NonIdealDiode_agents
boar.agents.TAS_agent
boar.agents.TranferMatrix_agent
boar.agents.TrMC_agent
boar.agents.TrPL_agent
boar.core
boar.core.FitParams
boar.core.funcs
boar.core.optimization
boar.core.optimization_botorch
boar.core.optimizer
boar.dynamic_utils
boar.dynamic_utils.pump
boar.dynamic_utils.rate_eq
boar.SIMsalabim_utils
boar.SIMsalabim_utils.aux_func
boar.SIMsalabim_utils.CalcFom
boar.SIMsalabim_utils.CleanFolder
boar.SIMsalabim_utils.CompileProg
boar.SIMsalabim_utils.Download_SIMsalabim
boar.SIMsalabim_utils.GetInputPar
boar.SIMsalabim_utils.MakeDevParFile
boar.SIMsalabim_utils.plot_settings_screen
boar.SIMsalabim_utils.PlotInputPar
boar.SIMsalabim_utils.RunSim
boar.SIMsalabim_utils.SimSS_plots
boar.SIMsalabim_utils.tVG_gen
boar.SIMsalabim_utils.ZimT_plots
MonoExpDecay() (in module boar.SIMsalabim_utils.aux_func)
MonoExpInc() (in module boar.SIMsalabim_utils.aux_func)
MooBOtorch (class in boar.core.optimization_botorch)
MultiObjectiveOptimizer (class in boar.core.optimization)
N
Non_Ideal_Diode_agent (class in boar.agents.NonIdealDiode_agents)
NonIdealDiode_dark() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
NonIdealDiode_dark_log() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
NonIdealDiode_light() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
NonIdealDiode_light_log() (boar.agents.NonIdealDiode_agents.Non_Ideal_Diode_agent method)
O
obj_func_curvefit() (boar.core.optimizer.BoarOptimizer method)
obj_func_metric() (boar.core.optimizer.BoarOptimizer method)
obj_func_scipy() (boar.core.optimizer.BoarOptimizer method)
obj_func_sko() (boar.core.optimization.MultiObjectiveOptimizer method)
openFile() (boar.agents.TranferMatrix_agent.Transfer_Matrix_agent method)
optimize_basin_hopping() (boar.core.optimizer.BoarOptimizer method)
optimize_curvefit() (boar.core.optimizer.BoarOptimizer method)
optimize_dual_annealing() (boar.core.optimizer.BoarOptimizer method)
optimize_sko_parallel() (boar.core.optimization.MultiObjectiveOptimizer method)
P
params_r() (boar.core.optimizer.BoarOptimizer method)
params_w() (boar.core.optimizer.BoarOptimizer method)
plot_all_objectives() (boar.core.optimization_botorch.MooBOtorch method)
plot_density() (boar.core.optimization_botorch.MooBOtorch method)
plot_fit_res() (boar.agents.Agent.Agent method)
plot_hypervolume() (boar.core.optimization_botorch.MooBOtorch method)
plot_input_dens() (in module boar.SIMsalabim_utils.PlotInputPar)
plot_input_mob() (in module boar.SIMsalabim_utils.PlotInputPar)
plot_input_nrj_diag() (in module boar.SIMsalabim_utils.PlotInputPar)
plot_input_SRH_lifetime() (in module boar.SIMsalabim_utils.PlotInputPar)
plot_objective_function() (boar.core.optimization.MultiObjectiveOptimizer method)
plot_params() (boar.agents.Agent.Agent method)
plot_results() (boar.agents.Agent.Agent method)
PlotDensSimSS() (in module boar.SIMsalabim_utils.SimSS_plots)
PlotDensWithTime() (in module boar.SIMsalabim_utils.SimSS_plots)
PlotJV() (in module boar.SIMsalabim_utils.SimSS_plots)
PlotJVPerf() (in module boar.SIMsalabim_utils.SimSS_plots)
PlotNrjDiagSimSS() (in module boar.SIMsalabim_utils.SimSS_plots)
PlotNrjDiagWithTime() (in module boar.SIMsalabim_utils.SimSS_plots)
polynom() (in module boar.core.funcs)
posterior() (boar.core.optimization.MultiObjectiveOptimizer method)
(boar.core.optimization_botorch.MooBOtorch method)
PrepareSimuInputs() (in module boar.SIMsalabim_utils.RunSim)
pump_from_file() (in module boar.dynamic_utils.pump)
R
randomize_grid_posterior() (boar.core.optimization.MultiObjectiveOptimizer method)
ReadParameterFile() (in module boar.SIMsalabim_utils.GetInputPar)
return_FOM() (boar.agents.DD_agents.Drift_diffusion_agent method)
run_code() (in module boar.SIMsalabim_utils.RunSim)
run_multiprocess_simu() (in module boar.SIMsalabim_utils.RunSim)
run_parallel_simu() (in module boar.SIMsalabim_utils.RunSim)
RunSimulation() (in module boar.SIMsalabim_utils.RunSim)
S
save_old_xy() (boar.core.optimization.MultiObjectiveOptimizer method)
sci_notation() (in module boar.core.funcs)
(in module boar.SIMsalabim_utils.aux_func)
should_stop_optimization() (boar.core.optimization_botorch.SimpleThresholdGlobalStoppingStrategy method)
sigmoid() (in module boar.core.funcs)
SimpleThresholdGlobalStoppingStrategy (class in boar.core.optimization_botorch)
single_point() (boar.core.optimization.MultiObjectiveOptimizer method)
square_pump() (in module boar.dynamic_utils.pump)
Store_output_in_folder() (in module boar.SIMsalabim_utils.CleanFolder)
StretchedExp() (in module boar.SIMsalabim_utils.aux_func)
T
TAS() (boar.agents.TAS_agent.TAS_agent method)
TAS_agent (class in boar.agents.TAS_agent)
Theta_B() (in module boar.SIMsalabim_utils.CalcFom)
Theta_T() (in module boar.SIMsalabim_utils.CalcFom)
Theta_T2() (in module boar.SIMsalabim_utils.CalcFom)
TM() (boar.agents.TranferMatrix_agent.Transfer_Matrix_agent method)
to_excel() (boar.agents.Agent.Agent method)
Transfer_Matrix_agent (class in boar.agents.TranferMatrix_agent)
trMC() (boar.agents.TrMC_agent.TrMC_agent method)
TrMC_agent (class in boar.agents.TrMC_agent)
trPL() (boar.agents.TrPL_agent.TrPL_agent method)
TrPL_agent (class in boar.agents.TrPL_agent)
U
update_FOMparam() (boar.core.FitParams.FOMparam method)
UpdateDevParFile() (in module boar.SIMsalabim_utils.MakeDevParFile)
V
valence_urbach() (in module boar.SIMsalabim_utils.aux_func)
Vbi() (in module boar.SIMsalabim_utils.CalcFom)
VisualizeDevParFile() (in module boar.SIMsalabim_utils.PlotInputPar)
W
w_int_L() (in module boar.SIMsalabim_utils.CalcFom)
w_int_R() (in module boar.SIMsalabim_utils.CalcFom)
X
Xy_to_dict() (boar.agents.Agent.Agent method)
Z
zimt_BACE() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_CELIV() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_dens_plot() (in module boar.SIMsalabim_utils.ZimT_plots)
zimt_impedance() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_JV_double_sweep() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_JV_sweep() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_light_decay() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_tdcf() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_tj_JV_plot() (in module boar.SIMsalabim_utils.ZimT_plots)
zimt_tj_plot() (in module boar.SIMsalabim_utils.ZimT_plots)
zimt_TPC_Gauss_pulse() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_TPC_square_pulse() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_TPV() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_TrPL() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_voltage_step() (in module boar.SIMsalabim_utils.tVG_gen)
zimt_Voltage_transient_plot() (in module boar.SIMsalabim_utils.ZimT_plots)