557 rename monte carlo failure probability to monte carlo limit state…

… probability (#576) * update MCS * update requirements * Update CHANGELOG.md * module rst * resolve merge conflict
IN-CORE · Jun 6, 2024 · 88d3b15 · 88d3b15
1 parent ba6e2e2
commit 88d3b15
Show file tree

Hide file tree

Showing 6 changed files with 418 additions and 372 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,35 +13,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Update Non-structural Building Damage to support flood [#562](https://github.com/IN-CORE/pyincore/issues/562)
 - Update flood input to non-structural building damage for combined wind-wave-surge building [#566](https://github.com/IN-CORE/pyincore/issues/566)
 - Rename transportation recovery analysis to traffic flow recovery analysis [#558](https://github.com/IN-CORE/pyincore/issues/558)
+- Rename Monte Carlo Failure Probability to Monte Carlo Limit State Probability [#557](https://github.com/IN-CORE/pyincore/issues/557)
+- Rename Housing Recovery to Housing Valuation Recovery Analysis [#560](https://github.com/IN-CORE/pyincore/issues/560)
+- Rename Building Portfolio Analysis to Building Cluster Recovery Analysis [#559](https://github.com/IN-CORE/pyincore/issues/559)
 - Rename nonstructural building damage [#537](https://github.com/IN-CORE/pyincore/issues/537)
 - Rename building damage to building structural damage [#561](https://github.com/IN-CORE/pyincore/issues/561)
 
 ### Added
 - Gas Facility Damage Analysis [#568](https://github.com/IN-CORE/pyincore/issues/568)
 - Copyrights to transportation recovery analysis [#579](https://github.com/IN-CORE/pyincore/issues/579)
 - Buyout Model Analyses [#539](https://github.com/IN-CORE/pyincore/issues/539)
+- Google Analytics to the documentation site [#547](https://github.com/IN-CORE/pyincore/issues/547)
 
 ### Fixed
 - Permission error in clearing cache process [#563](https://github.com/IN-CORE/pyincore/issues/563)
-
-
-## [Unreleased] 
-
-### Changed
-- Rename Housing Recovery to Housing Valuation Recovery Analysis [#560](https://github.com/IN-CORE/pyincore/issues/560)
-
-
-## [Unreleased]
-
-### Changed
-- Rename Building Portfolio Analysis to Building Cluster Recovery Analysis [#559](https://github.com/IN-CORE/pyincore/issues/559)
-
-
-## [Unrelased]
-
-### Fixed
 - Out of index error in dfr3 service's property conversion when the rule is not found [#555](https://github.com/IN-CORE/pyincore/issues/555)
 
+
 ## [1.18.1] - 2024-04-30
 
 ### Changed
@@ -56,11 +44,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Unnecessary dependency in setup.py [#519](https://github.com/IN-CORE/pyincore/issues/519)
 
 
-## [Unreleased]
-
-### Added
-- Google Analytics to the documentation site [#547](https://github.com/IN-CORE/pyincore/issues/547)
-
 ## [1.18.0] - 2024-04-03
 
 ### Added

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -68,7 +68,7 @@ analyses/combinedwindwavesurgebuildingdamage
     :members:
 
 analyses/combinedwindwavesurgebuildingloss
-============================================
+==========================================
 ..  autoclass:: pyincore.analyses.combinedwindwavesurgebuildingloss.CombinedWindWaveSurgeBuildingLoss
     :members:
 
@@ -78,7 +78,7 @@ analyses/commercialbuildingrecovery
     :members:
 
 analyses/core_cge_ml
-===================================
+====================
 ..  autoclass:: core_cge_ml.corecgeml.CoreCGEML
     :members:
 
@@ -100,7 +100,7 @@ analyses/epfdamage
     :members:
 
 analyses/epfrepaircost
-==================
+======================
 ..  autoclass:: epfrepaircost.epfrepaircost.EpfRepairCost
     :members:
 
@@ -117,7 +117,7 @@ analyses/example
     :members:
 
 analyses/galvestoncge
-==================
+=====================
 ..  autoclass:: galvestoncge.galvestoncge.GalvestonCGEModel
     :members:
 ..  autoclass:: galvestoncge.equationlib.VarContainer
@@ -140,7 +140,7 @@ analyses/galvestoncge
     :members:
 
 analyses/gasfacilitydamage
-============================
+==========================
 ..  autoclass:: gasfacilitydamage.gasfacilitydamage.GasFacilityDamage
     :members:
 ..  autoclass:: gasfacilitydamage.gfutil.GfUtil
@@ -162,14 +162,14 @@ analyses/housingunitallocation
     :members:
 
 analyses/housingvaluationrecovery
-========================
+=================================
 ..  autoclass:: housingvaluationrecovery.housingvaluationrecovery.HousingValuationRecovery
     :members:
 ..  autoclass:: housingvaluationrecovery.housingvaluationrecoveryutil.HousingValuationRecoveryUtil
     :members:
 
 analyses/indp
-==============================
+=============
 ..  autoclass:: indp.indp.INDP
     :members:
 ..  autoclass:: indp.dislocationutils.DislocationUtil
@@ -215,7 +215,7 @@ analyses/joplincge
     :members:
 
 analyses/joplinempiricalbuildingrestoration
-===================================
+===========================================
 ..  autoclass:: joplinempiricalbuildingrestoration.joplinempiricalbuildingrestoration.JoplinEmpiricalBuildingRestoration
     :members:
 ..  autoclass:: joplinempiricalbuildingrestoration.joplinempirrestor_util.JoplinEmpirRestorUtil
@@ -227,13 +227,18 @@ analyses/meandamage
     :members:
 
 analyses/mlenabledcgeslc
-===================
+========================
 ..  autoclass:: mlenabledcgeslc.mlcgeslc.MlEnabledCgeSlc
     :members:
 
 analyses/montecarlofailureprobability
 =====================================
-..  autoclass:: montecarlofailureprobability.montecarlofailureprobability.MonteCarloFailureProbability
+.. deprecated:: 1.19.0
+   This class will be deprecated soon. Use :class:`montecarlolimitstateprobability.MonteCarloLimitStateProbability` instead.
+
+analyses/montecarlolimitstateprobability
+========================================
+..  autoclass:: montecarlolimitstateprobability.montecarlolimitstateprobability.MonteCarloLimitStateProbability
     :members:
 
 analyses/multiobjectiveretrofitoptimization
@@ -268,12 +273,12 @@ analyses/pipelinedamagerepairrate
     :members:
 
 analyses/pipelinefunctionality
-=========================
+==============================
 ..  autoclass:: pipelinefunctionality.pipelinefunctionality.PipelineFunctionality
     :members:
 
 analyses/pipelinerepaircost
-============================
+===========================
 ..  autoclass:: pipelinerepaircost.pipelinerepaircost.PipelineRepairCost
     :members:
 
@@ -315,7 +320,7 @@ analyses/seasidecge
     :members:
 
 analyses/saltlakecge
-==================
+====================
 ..  autoclass:: saltlakecge.saltlakecge.SaltLakeCGEModel
     :members:
 ..  autoclass:: saltlakecge.equationlib.VarContainer
@@ -345,7 +350,7 @@ analyses/socialvulnerability
     This class will be deprecated soon. Use :class:`socialvulnerabilityscore.SocialVulnerabilityScore` instead.
 
 analyses/socialvulnerabilityscore
-============================
+=================================
 ..  autoclass:: socialvulnerabilityscore.socialvulnerabilityscore.SocialVulnerabilityScore
     :members:
 
@@ -378,7 +383,7 @@ analyses/transportationrecovery
     This class will be deprecated soon. Use :class:`trafficflowrecovery.TrafficFlowRecovery` instead.
 
 analyses/trafficflowrecovery
-===============================
+============================
 ..  autoclass:: trafficflowrecovery.trafficflowrecovery.TrafficFlowRecovery
     :members:
 ..  autoclass:: trafficflowrecovery.trafficflowrecoveryutil.TrafficFlowRecoveryUtil
@@ -404,7 +409,7 @@ analyses/waterfacilitydamage
     :members:
 
 analyses/waterfacilityrepaircost
-=================================
+================================
 ..  autoclass:: waterfacilityrepaircost.waterfacilityrepaircost.WaterFacilityRepairCost
     :members:
 
@@ -414,15 +419,15 @@ analyses/waterfacilityrestoration
     :members:
 
 analyses/wfnfunctionality
-=================================
+=========================
 ..  autoclass:: wfnfunctionality.wfnfunctionality.WfnFunctionality
     :members:
 
 models
 ^^^^^^
 
 models/hazard/earthquake
-===================
+========================
 ..  autoclass:: models.earthquake.Earthquake
     :members:
 
@@ -432,7 +437,7 @@ models/hazard/flood
     :members:
 
 models/hazard/hazard
-===================
+====================
 ..  autoclass:: models.hazard.Hazard
     :members:
 
@@ -487,7 +492,7 @@ models/mappingset
     :members:
 
 models/networkdataset
-=================
+=====================
 ..  autoclass:: models.networkdataset.NetworkDataset
     :members:
 
@@ -502,7 +507,7 @@ models/restorationcurveset
     :members:
 
 models/units
-==========================
+============
 ..  autoclass:: models.units.Units
     :members:
 
@@ -515,7 +520,7 @@ utils/analysisutil
     :members:
 
 utils/cge_ml_file_util
-==================
+======================
 ..  autoclass:: utils.cge_ml_file_util.CGEMLFileUtil
     :members: