About
1. Copyright and license
2. Citing pelicun
3. Logo
4. Acknowledgments
4.1. National Science Foundation
4.2. Contributors
5. Release Notes
5.1. Version 3.0
5.2. Version 2.0
5.3. Version 1.0
User Guide
1. Getting started
1.1. Staying up to date
2. The Pelicun Framework
2.1. Abbreviations
2.2. Introduction to Pelicun
2.3. Overview
2.4. Performance Assessment Workflow
2.5. Response Model
2.6. Performance Model
2.7. Damage Model
2.8. Loss Model
3. Overview of pelicun features
3.1. Saving/loading samples
3.2. Logging support
3.3. Uncertainty quantification
3.4. Assessment types
3.5. Demand simulation
3.6. Damage estimation
3.7. Loss estimation
3.8. Command-line support
3.9. Standalone tools
3.10. Feature overview and examples
4. Damage and loss library
5. Bug reports and feature requests
6. Resources for new python users
7. Examples
7.1. Example 1: Simple loss function.
7.2. Example 2: Damage state validation.
7.3. Example 3: Combining fragility-based damage consequences and loss functions.
8. API Reference
8.1. pelicun
Developer Guide
1. Getting started
1.1. Code of conduct
1.2. How to contribute
2. Setting up a development environment
3. Coding practice
3.1. Code quality assurance
3.2. Unit tests
3.3. Documentation
4. Package architecture
4.1. Overview of files
pelicun
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
add_loss_map() (pelicun.model.loss_model.LossModel method)
add_RV() (pelicun.uq.RandomVariableRegistry method)
add_RV_set() (pelicun.uq.RandomVariableRegistry method)
add_warning() (pelicun.base.Logger method)
aggregate_loss() (pelicun.assessment.Assessment method)
aggregate_losses() (pelicun.model.loss_model.LossModel method)
all_test_files() (in module pelicun.tests.code_repetition_checker)
apply_correlation() (pelicun.uq.RandomVariableSet method)
Assessment (class in pelicun.assessment)
AssessmentBase (class in pelicun.assessment)
AssetModel (class in pelicun.model.asset_model)
auto_populate() (in module pelicun.auto)
B
BaseRandomVariable (class in pelicun.uq)
bldg_repair (pelicun.assessment.AssessmentBase property)
C
calc_unit_scale_factor() (pelicun.assessment.AssessmentBase method)
calculate() (pelicun.model.damage_model.DamageModel method)
(pelicun.model.loss_model.LossModel method)
(pelicun.model.loss_model.RepairModel_DS method)
(pelicun.model.loss_model.RepairModel_LF method)
calculate_asset() (pelicun.assessment.DLCalculationAssessment method)
calculate_damage() (pelicun.assessment.Assessment method)
(pelicun.assessment.DLCalculationAssessment method)
calculate_demand() (pelicun.assessment.DLCalculationAssessment method)
calculate_loss() (pelicun.assessment.Assessment method)
(pelicun.assessment.DLCalculationAssessment method)
calibrate_model() (pelicun.model.demand_model.DemandModel method)
cdf() (pelicun.uq.LogNormalRandomVariable method)
(pelicun.uq.MultilinearCDFRandomVariable method)
(pelicun.uq.NormalRandomVariable method)
(pelicun.uq.UniformRandomVariable method)
(pelicun.uq.WeibullRandomVariable method)
check_if_str_is_na() (in module pelicun.base)
clone_demands() (pelicun.model.demand_model.DemandModel method)
complete_ds_cols() (pelicun.model.damage_model.DamageModel_DS method)
consequence_scaling() (pelicun.model.loss_model.LossModel method)
constant_parameters() (pelicun.uq.RandomVariable method)
control_warnings() (in module pelicun.base)
convert_damage_parameter_units() (pelicun.model.damage_model.DamageModel_Base method)
convert_df_to_dict() (in module pelicun.tools.DL_calculation)
convert_dtypes() (in module pelicun.base)
convert_loss_parameter_units() (pelicun.model.loss_model.RepairModel_Base method)
(pelicun.model.loss_model.RepairModel_DS method)
(pelicun.model.loss_model.RepairModel_LF method)
convert_to_MultiIndex() (in module pelicun.base)
convert_to_SimpleIndex() (in module pelicun.base)
convert_units() (in module pelicun.base)
CoupledEmpiricalRandomVariable (class in pelicun.uq)
D
DamageModel (class in pelicun.model.damage_model)
DamageModel_Base (class in pelicun.model.damage_model)
DamageModel_DS (class in pelicun.model.damage_model)
decision_variables (pelicun.model.loss_model.LossModel property)
dedupe_index() (in module pelicun.base)
DemandModel (class in pelicun.model.demand_model)
describe() (in module pelicun.base)
DeterministicRandomVariable (class in pelicun.uq)
dict_raise_on_duplicates() (in module pelicun.base)
div() (pelicun.base.Logger method)
DLCalculationAssessment (class in pelicun.assessment)
drop_unused_damage_parameters() (pelicun.model.damage_model.DamageModel_Base method)
drop_unused_damage_states() (pelicun.model.loss_model.RepairModel_DS method)
drop_unused_loss_parameters() (pelicun.model.loss_model.RepairModel_Base method)
E
emit_warnings() (pelicun.base.Logger method)
EmpiricalRandomVariable (class in pelicun.uq)
ensure_value() (in module pelicun.base)
estimate_RID() (pelicun.model.demand_model.DemandModel method)
estimate_RID_and_adjust_sample() (pelicun.model.demand_model.DemandModel method)
expand_sample() (pelicun.model.demand_model.DemandModel method)
export_pickle() (in module pelicun.tests.util)
F
find_functions_with_string() (in module pelicun.tests.maintenance.search_in_functions)
fit_distribution_to_percentiles() (in module pelicun.uq)
fit_distribution_to_sample() (in module pelicun.uq)
float_or_None() (in module pelicun.base)
G
generate_cmp_sample() (pelicun.model.asset_model.AssetModel method)
generate_sample() (pelicun.model.demand_model.DemandModel method)
(pelicun.uq.RandomVariableRegistry method)
get() (in module pelicun.base)
get_available() (pelicun.model.loss_model.RepairModel_Base method)
get_default_data() (pelicun.assessment.AssessmentBase method)
get_default_metadata() (pelicun.assessment.AssessmentBase method)
I
import_pickle() (in module pelicun.tests.util)
InconsistentUnitsError
int_or_None() (in module pelicun.base)
inverse_transform() (pelicun.uq.CoupledEmpiricalRandomVariable method)
(pelicun.uq.DeterministicRandomVariable method)
(pelicun.uq.EmpiricalRandomVariable method)
(pelicun.uq.LogNormalRandomVariable method)
(pelicun.uq.MultilinearCDFRandomVariable method)
(pelicun.uq.MultinomialRandomVariable method)
(pelicun.uq.NormalRandomVariable method)
(pelicun.uq.RandomVariable method)
(pelicun.uq.UniformRandomVariable method)
(pelicun.uq.UtilityRandomVariable method)
(pelicun.uq.WeibullRandomVariable method)
inverse_transform_sampling() (pelicun.uq.RandomVariable method)
(pelicun.uq.UtilityRandomVariable method)
invert_mapping() (in module pelicun.base)
is_specified() (in module pelicun.base)
is_unspecified() (in module pelicun.base)
L
list_unique_component_ids() (pelicun.model.asset_model.AssetModel method)
load_cmp_model() (pelicun.model.asset_model.AssetModel method)
load_cmp_sample() (pelicun.model.asset_model.AssetModel method)
load_consequence_info() (pelicun.assessment.DLCalculationAssessment method)
load_damage_model() (pelicun.model.damage_model.DamageModel method)
load_data() (in module pelicun.file_io)
load_default_options() (in module pelicun.base)
load_from_file() (in module pelicun.file_io)
load_model() (pelicun.model.demand_model.DemandModel method)
(pelicun.model.loss_model.LossModel method)
load_model_parameters() (pelicun.model.damage_model.DamageModel method)
(pelicun.model.damage_model.DamageModel_Base method)
(pelicun.model.loss_model.LossModel method)
(pelicun.model.loss_model.RepairModel_Base method)
load_sample() (pelicun.model.damage_model.DamageModel method)
(pelicun.model.demand_model.DemandModel method)
(pelicun.model.loss_model.LossModel method)
(pelicun.model.loss_model.RepairModel_DS method)
log_exception() (pelicun.base.LoggerRegistry class method)
log_msg() (in module pelicun.tools.DL_calculation)
Logger (class in pelicun.base)
LoggerRegistry (class in pelicun.base)
LogNormalRandomVariable (class in pelicun.uq)
loss_params (pelicun.model.loss_model.LossModel property)
LossModel (class in pelicun.model.loss_model)
M
main() (in module pelicun.tests.code_repetition_checker)
(in module pelicun.tools.DL_calculation)
merge_default_config() (in module pelicun.base)
module
pelicun
pelicun.assessment
pelicun.auto
pelicun.base
pelicun.file_io
pelicun.model
pelicun.model.asset_model
pelicun.model.damage_model
pelicun.model.demand_model
pelicun.model.loss_model
pelicun.model.pelicun_model
pelicun.pelicun_warnings
pelicun.tests
pelicun.tests.basic
pelicun.tests.basic.reset_tests
pelicun.tests.basic.test_assessment
pelicun.tests.basic.test_asset_model
pelicun.tests.basic.test_auto
pelicun.tests.basic.test_base
pelicun.tests.basic.test_damage_model
pelicun.tests.basic.test_demand_model
pelicun.tests.basic.test_file_io
pelicun.tests.basic.test_loss_model
pelicun.tests.basic.test_model
pelicun.tests.basic.test_pelicun_model
pelicun.tests.basic.test_uq
pelicun.tests.code_repetition_checker
pelicun.tests.dl_calculation
pelicun.tests.dl_calculation.e1
pelicun.tests.dl_calculation.e1.test_e1
pelicun.tests.dl_calculation.e1_no_autopop
pelicun.tests.dl_calculation.e1_no_autopop.test_e1
pelicun.tests.dl_calculation.e2
pelicun.tests.dl_calculation.e2.test_e2
pelicun.tests.dl_calculation.e3
pelicun.tests.dl_calculation.e3.test_e3
pelicun.tests.dl_calculation.e4
pelicun.tests.dl_calculation.e4.test_e4
pelicun.tests.dl_calculation.e5
pelicun.tests.dl_calculation.e5.test_e5
pelicun.tests.dl_calculation.e6
pelicun.tests.dl_calculation.e6.test_e6
pelicun.tests.dl_calculation.e7
pelicun.tests.dl_calculation.e7.test_e7
pelicun.tests.dl_calculation.e8
pelicun.tests.dl_calculation.e8.test_e8
pelicun.tests.dl_calculation.e9
pelicun.tests.dl_calculation.e9.test_e9
pelicun.tests.maintenance
pelicun.tests.maintenance.search_in_functions
pelicun.tests.util
pelicun.tests.validation
pelicun.tests.validation.inactive
pelicun.tests.validation.inactive.pandas_convert_speed
pelicun.tests.validation.v0
pelicun.tests.validation.v0.test_validation_0
pelicun.tests.validation.v1
pelicun.tests.validation.v1.test_validation_1
pelicun.tests.validation.v2
pelicun.tests.validation.v2.test_validation_2
pelicun.tools
pelicun.tools.DL_calculation
pelicun.tools.HDF_to_CSV
pelicun.uq
msg() (pelicun.base.Logger method)
MultilinearCDFRandomVariable (class in pelicun.uq)
MultinomialRandomVariable (class in pelicun.uq)
multiply_factor_multiple_levels() (in module pelicun.base)
mvn_orthotope_density() (in module pelicun.uq)
N
Normal_COV (class in pelicun.uq)
Normal_STD (class in pelicun.uq)
NormalRandomVariable (class in pelicun.uq)
O
obtain_ds_sample() (pelicun.model.damage_model.DamageModel_DS method)
Options (class in pelicun.base)
orthotope_density() (pelicun.uq.RandomVariableSet method)
P
parse_units() (in module pelicun.base)
pelicun
module
pelicun.assessment
module
pelicun.auto
module
pelicun.base
module
pelicun.file_io
module
pelicun.model
module
pelicun.model.asset_model
module
pelicun.model.damage_model
module
pelicun.model.demand_model
module
pelicun.model.loss_model
module
pelicun.model.pelicun_model
module
pelicun.pelicun_warnings
module
pelicun.tests
module
pelicun.tests.basic
module
pelicun.tests.basic.reset_tests
module
pelicun.tests.basic.test_assessment
module
pelicun.tests.basic.test_asset_model
module
pelicun.tests.basic.test_auto
module
pelicun.tests.basic.test_base
module
pelicun.tests.basic.test_damage_model
module
pelicun.tests.basic.test_demand_model
module
pelicun.tests.basic.test_file_io
module
pelicun.tests.basic.test_loss_model
module
pelicun.tests.basic.test_model
module
pelicun.tests.basic.test_pelicun_model
module
pelicun.tests.basic.test_uq
module
pelicun.tests.code_repetition_checker
module
pelicun.tests.dl_calculation
module
pelicun.tests.dl_calculation.e1
module
pelicun.tests.dl_calculation.e1.test_e1
module
pelicun.tests.dl_calculation.e1_no_autopop
module
pelicun.tests.dl_calculation.e1_no_autopop.test_e1
module
pelicun.tests.dl_calculation.e2
module
pelicun.tests.dl_calculation.e2.test_e2
module
pelicun.tests.dl_calculation.e3
module
pelicun.tests.dl_calculation.e3.test_e3
module
pelicun.tests.dl_calculation.e4
module
pelicun.tests.dl_calculation.e4.test_e4
module
pelicun.tests.dl_calculation.e5
module
pelicun.tests.dl_calculation.e5.test_e5
module
pelicun.tests.dl_calculation.e6
module
pelicun.tests.dl_calculation.e6.test_e6
module
pelicun.tests.dl_calculation.e7
module
pelicun.tests.dl_calculation.e7.test_e7
module
pelicun.tests.dl_calculation.e8
module
pelicun.tests.dl_calculation.e8.test_e8
module
pelicun.tests.dl_calculation.e9
module
pelicun.tests.dl_calculation.e9.test_e9
module
pelicun.tests.maintenance
module
pelicun.tests.maintenance.search_in_functions
module
pelicun.tests.util
module
pelicun.tests.validation
module
pelicun.tests.validation.inactive
module
pelicun.tests.validation.inactive.pandas_convert_speed
module
pelicun.tests.validation.v0
module
pelicun.tests.validation.v0.test_validation_0
module
pelicun.tests.validation.v1
module
pelicun.tests.validation.v1.test_validation_1
module
pelicun.tests.validation.v2
module
pelicun.tests.validation.v2.test_validation_2
module
pelicun.tools
module
pelicun.tools.DL_calculation
module
pelicun.tools.HDF_to_CSV
module
pelicun.uq
module
PelicunInvalidConfigError
PelicunModel (class in pelicun.model.pelicun_model)
PelicunWarning
perform_dmg_task() (pelicun.model.damage_model.DamageModel_DS method)
prepare_dmg_quantities() (pelicun.model.damage_model.DamageModel_DS method)
print_system_info() (pelicun.base.Logger method)
probabilities() (pelicun.model.damage_model.DamageModel_DS method)
Q
query_error_setup() (pelicun.model.pelicun_model.PelicunModel method)
R
RandomVariable (class in pelicun.uq)
RandomVariableRegistry (class in pelicun.uq)
RandomVariableSet (class in pelicun.uq)
register() (pelicun.base.LoggerRegistry class method)
remove_incomplete_components() (pelicun.model.damage_model.DamageModel_Base method)
(pelicun.model.loss_model.RepairModel_Base method)
repair (pelicun.assessment.AssessmentBase property)
RepairModel_Base (class in pelicun.model.loss_model)
RepairModel_DS (class in pelicun.model.loss_model)
RepairModel_LF (class in pelicun.model.loss_model)
reset_all_test_data() (in module pelicun.tests.basic.reset_tests)
reset_log_strings() (pelicun.base.Logger method)
Rho() (pelicun.uq.RandomVariableSet method)
rng (pelicun.base.Options property)
run_pelicun() (in module pelicun.tools.DL_calculation)
RV (pelicun.uq.RandomVariableRegistry property)
(pelicun.uq.RandomVariableSet property)
rv_class_map() (in module pelicun.uq)
RV_sample (pelicun.uq.RandomVariableRegistry property)
RV_set (pelicun.uq.RandomVariableRegistry property)
RVs() (pelicun.uq.RandomVariableRegistry method)
S
sample (pelicun.model.damage_model.DamageModel property)
(pelicun.model.loss_model.LossModel property)
(pelicun.uq.BaseRandomVariable property)
(pelicun.uq.RandomVariableSet property)
sample_DF (pelicun.uq.BaseRandomVariable property)
save_cmp_sample() (pelicun.model.asset_model.AssetModel method)
save_model() (pelicun.model.demand_model.DemandModel method)
save_sample() (pelicun.model.damage_model.DamageModel method)
(pelicun.model.demand_model.DemandModel method)
(pelicun.model.loss_model.LossModel method)
(pelicun.model.loss_model.RepairModel_DS method)
save_to_csv() (in module pelicun.file_io)
scale_distribution() (in module pelicun.uq)
scale_factor() (pelicun.assessment.AssessmentBase method)
seed (pelicun.base.Options property)
show_matrix() (in module pelicun.base)
size (pelicun.uq.RandomVariableSet property)
split_file_name() (in module pelicun.base)
str2bool() (in module pelicun.base)
stringterpolation() (in module pelicun.base)
substitute_default_path() (in module pelicun.file_io)
T
TimeBasedAssessment (class in pelicun.assessment)
U
uni_sample (pelicun.uq.BaseRandomVariable property)
UniformRandomVariable (class in pelicun.uq)
update() (in module pelicun.base)
update_vals() (in module pelicun.base)
UtilityRandomVariable (class in pelicun.uq)
V
visit_FunctionDef() (in module pelicun.tests.maintenance.search_in_functions)
W
warning() (pelicun.base.Logger method)
WeibullRandomVariable (class in pelicun.uq)
with_parsed_str_na_values() (in module pelicun.base)