deploy: 303dbd6

ioannis-vm · Oct 22, 2024 · 1a09ae1 · 1a09ae1
1 parent 8cddc6c
commit 1a09ae1
Show file tree

Hide file tree

Showing 292 changed files with 734,920 additions and 7,723 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8db301e900ad5e234b82d26ea20518ff
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b4c23dbca101faa3c7c31a35a0c02442
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_images/pelicun-Logo-white.png b/_images/pelicun-Logo-white.png
diff --git a/_modules/index.html b/_modules/index.html
diff --git a/_modules/pelicun/assessment.html b/_modules/pelicun/assessment.html
diff --git a/_modules/pelicun/auto.html b/_modules/pelicun/auto.html
diff --git a/_modules/pelicun/base.html b/_modules/pelicun/base.html
diff --git a/_modules/pelicun/file_io.html b/_modules/pelicun/file_io.html
diff --git a/_modules/pelicun/model/asset_model.html b/_modules/pelicun/model/asset_model.html
diff --git a/_modules/pelicun/model/damage_model.html b/_modules/pelicun/model/damage_model.html
diff --git a/_modules/pelicun/model/demand_model.html b/_modules/pelicun/model/demand_model.html
diff --git a/_modules/pelicun/model/loss_model.html b/_modules/pelicun/model/loss_model.html
diff --git a/_modules/pelicun/model/pelicun_model.html b/_modules/pelicun/model/pelicun_model.html
diff --git a/_modules/pelicun/warnings.html → _modules/pelicun/pelicun_warnings.html b/_modules/pelicun/warnings.html → _modules/pelicun/pelicun_warnings.html
diff --git a/_modules/pelicun/tests/basic/reset_tests.html b/_modules/pelicun/tests/basic/reset_tests.html
diff --git a/_modules/pelicun/tests/code_repetition_checker.html b/_modules/pelicun/tests/code_repetition_checker.html
diff --git a/_modules/pelicun/tests/dl_calculation/e7/auto_HU_NJ.html b/_modules/pelicun/tests/dl_calculation/e7/auto_HU_NJ.html
diff --git a/_modules/pelicun/tests/dl_calculation/e8/auto_HU_LA.html b/_modules/pelicun/tests/dl_calculation/e8/auto_HU_LA.html
diff --git a/_modules/pelicun/tests/dl_calculation/e9/custom_pop.html b/_modules/pelicun/tests/dl_calculation/e9/custom_pop.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/BldgClassRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/BldgClassRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/BuildingClassRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/BuildingClassRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/FloodAssmRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/FloodAssmRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/FloodClassRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/FloodClassRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/FloodRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/FloodRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/MetaVarRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/MetaVarRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindCECBRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindCECBRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindCERBRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindCERBRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindEFRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindEFRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMECBRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMECBRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMERBRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMERBRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMHRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMHRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMLRIRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMLRIRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMLRMRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMLRMRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMMUHRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMMUHRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMSFRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMSFRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindMetaVarRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindMetaVarRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindSECBRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindSECBRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindSERBRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindSERBRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindSPMBRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindSPMBRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindWMUHRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindWMUHRulesets.html
diff --git a/_modules/pelicun/tests/dl_calculation/rulesets/WindWSFRulesets.html b/_modules/pelicun/tests/dl_calculation/rulesets/WindWSFRulesets.html
diff --git a/_modules/pelicun/tests/maintenance/search_in_functions.html b/_modules/pelicun/tests/maintenance/search_in_functions.html
diff --git a/_modules/pelicun/tests/util.html b/_modules/pelicun/tests/util.html
diff --git a/_modules/pelicun/tools/DL_calculation.html b/_modules/pelicun/tools/DL_calculation.html
diff --git a/_modules/pelicun/uq.html b/_modules/pelicun/uq.html
diff --git a/_sources/other/acknowledgments.rst.txt → _sources/about/acknowledgments.rst.txt b/_sources/other/acknowledgments.rst.txt → _sources/about/acknowledgments.rst.txt
diff --git a/_sources/about/cite.rst.txt b/_sources/about/cite.rst.txt
@@ -0,0 +1,36 @@
+.. _cite:
+
+Citing pelicun
+--------------
+
+When referencing pelicun in your research or publications, please use the following citation.
+Proper citation is crucial for acknowledging the efforts of the development team and ensuring the reproducibility of your work.
+
+.. card:: Latest pelicun citation
+   :link: https://zenodo.org/doi/10.5281/zenodo.2558557
+
+   .. latest-citation::
+
+
+Logo
+----
+
+.. image:: ../_static/pelicun-Logo-white.png
+   :alt: NHERI-SimCenter pelicun logo
+   :align: center
+
+The pelicun logo is a trademark of NHERI-SimCenter and is protected under applicable trademark laws.
+You are permitted to use the pelicun logo under the following conditions:
+
+1. **Non-Commercial Use**: The logo may be used for non-commercial purposes, including academic publications, presentations, and educational materials, provided that such use is directly related to the pelicun software.
+
+2. **Integrity of the Logo**: The logo must not be altered, modified, or distorted in any way.
+   This includes changes to the logo's proportions, colors, and text, except for resizing that maintains the original aspect ratio.
+
+3. **Attribution**: Any use of the logo must be accompanied by an attribution to "NHERI-SimCenter" as the owner of the pelicun logo.
+
+4. **Prohibited Uses**: The logo must not be used in any manner that suggests endorsement or sponsorship by NHERI-SimCenter of any third-party products, services, or organizations, unless explicit permission has been granted.
+
+5. **Legal Compliance**: The use of the pelicun logo must comply with all applicable laws and regulations, including those related to trademark and intellectual property rights.
+
+For any uses not covered by the above terms, or to seek permission for commercial use, please contact NHERI-SimCenter directly.
diff --git a/_sources/other/license.rst.txt → _sources/about/license.rst.txt b/_sources/other/license.rst.txt → _sources/about/license.rst.txt
diff --git a/_sources/api_reference/_autosummary/pelicun.assessment.rst.txt b/_sources/api_reference/_autosummary/pelicun.assessment.rst.txt
@@ -10,12 +10,6 @@ pelicun.assessment
 
 
 
-   .. rubric:: Functions
-
-   .. autosummary::
-
-      load_consequence_info
-
 
 
 

diff --git a/_sources/api_reference/_autosummary/pelicun.base.rst.txt b/_sources/api_reference/_autosummary/pelicun.base.rst.txt
@@ -22,6 +22,7 @@ pelicun.base
       dedupe_index
       describe
       dict_raise_on_duplicates
+      ensure_value
       float_or_None
       get
       int_or_None

diff --git a/...nce/_autosummary/pelicun.warnings.rst.txt → ...osummary/pelicun.pelicun_warnings.rst.txt b/...nce/_autosummary/pelicun.warnings.rst.txt → ...osummary/pelicun.pelicun_warnings.rst.txt
@@ -1,7 +1,7 @@
-pelicun.warnings
-================
+pelicun.pelicun\_warnings
+=========================
 
-.. automodule:: pelicun.warnings
+.. automodule:: pelicun.pelicun_warnings
    :members:
 
 

diff --git a/_sources/api_reference/_autosummary/pelicun.rst.txt b/_sources/api_reference/_autosummary/pelicun.rst.txt
@@ -34,7 +34,8 @@
    base
    file_io
    model
+   pelicun_warnings
    tests
+   tools
    uq
-   warnings
 
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.reset_tests.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.reset_tests.rst.txt
@@ -0,0 +1,30 @@
+pelicun.tests.basic.reset\_tests
+================================
+
+.. automodule:: pelicun.tests.basic.reset_tests
+   :members:
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      reset_all_test_data
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.rst.txt
@@ -0,0 +1,44 @@
+pelicun.tests.basic
+===================
+
+.. automodule:: pelicun.tests.basic
+   :members:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+
+   reset_tests
+   test_assessment
+   test_asset_model
+   test_auto
+   test_base
+   test_damage_model
+   test_demand_model
+   test_file_io
+   test_loss_model
+   test_model
+   test_pelicun_model
+   test_uq
+
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.test_assessment.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.test_assessment.rst.txt
@@ -0,0 +1,34 @@
+pelicun.tests.basic.test\_assessment
+====================================
+
+.. automodule:: pelicun.tests.basic.test_assessment
+   :members:
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      create_assessment_obj
+      test_Assessment_init
+      test_assessment_calc_unit_scale_factor
+      test_assessment_get_default_metadata
+      test_assessment_scale_factor
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.test_asset_model.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.test_asset_model.rst.txt
@@ -0,0 +1,31 @@
+pelicun.tests.basic.test\_asset\_model
+======================================
+
+.. automodule:: pelicun.tests.basic.test_asset_model
+   :members:
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :template: custom-class-template.rst
+
+      TestAssetModel
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.test_auto.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.test_auto.rst.txt
@@ -0,0 +1,36 @@
+pelicun.tests.basic.test\_auto
+==============================
+
+.. automodule:: pelicun.tests.basic.test_auto
+   :members:
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      setup_auto_script_path
+      setup_expected_base_path
+      setup_valid_config
+      test_auto_population_script_execution
+      test_missing_general_information
+      test_pelicun_default_path_replacement
+      test_valid_inputs
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.test_base.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.test_base.rst.txt
@@ -0,0 +1,55 @@
+pelicun.tests.basic.test\_base
+==============================
+
+.. automodule:: pelicun.tests.basic.test_base
+   :members:
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      test_convert_dtypes
+      test_convert_to_MultiIndex
+      test_convert_to_SimpleIndex
+      test_dedupe_index
+      test_describe
+      test_dict_raise_on_duplicates
+      test_float_or_None
+      test_int_or_None
+      test_invert_mapping
+      test_logger_div
+      test_logger_init
+      test_logger_msg
+      test_merge_default_config
+      test_multiply_factor_multiple_levels
+      test_nondir_multi
+      test_options_init
+      test_parse_units
+      test_print_system_info
+      test_run_input_specs
+      test_show_matrix
+      test_split_file_name
+      test_str2bool
+      test_stringterpolation
+      test_unit_conversion
+      test_update_vals
+      test_with_parsed_str_na_values
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.test_damage_model.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.test_damage_model.rst.txt
@@ -0,0 +1,39 @@
+pelicun.tests.basic.test\_damage\_model
+=======================================
+
+.. automodule:: pelicun.tests.basic.test_damage_model
+   :members:
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      test__is_for_ds_model
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :template: custom-class-template.rst
+
+      TestDamageModel
+      TestDamageModel_Base
+      TestDamageModel_DS
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api_reference/_autosummary/pelicun.tests.basic.test_demand_model.rst.txt b/_sources/api_reference/_autosummary/pelicun.tests.basic.test_demand_model.rst.txt
@@ -0,0 +1,31 @@
+pelicun.tests.basic.test\_demand\_model
+=======================================
+
+.. automodule:: pelicun.tests.basic.test_demand_model
+   :members:
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :template: custom-class-template.rst
+
+      TestDemandModel
+
+
+
+
+
+
+
+
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,12 +10,6 @@ pelicun.assessment



		.. rubric:: Functions

		.. autosummary::

		load_consequence_info




Expand Down
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,7 +34,8 @@ @@
        base
        file_io
        model
+       pelicun_warnings
        tests
+       tools
        uq
-       warnings