Merge pull request #99 from Deltares/feature/96-refactor-improve-dist…

…inction-between-reinforcementinputprofile-and-reinforcementprofile Feature/96 refactor improve distinction between reinforcementinputprofile and reinforcementprofile
Deltares · Oct 24, 2023 · c8cce65 · c8cce65
2 parents 3fcca28 + d7063c9
commit c8cce65
Show file tree

Hide file tree

Showing 108 changed files with 755 additions and 677 deletions.
diff --git a/docs/reference/koswat_docstrings/calculations/protocols.md b/docs/reference/koswat_docstrings/calculations/protocols.md
diff --git a/docs/reference/koswat_docstrings/calculations/reinforcement_layers.md b/docs/reference/koswat_docstrings/calculations/reinforcement_layers.md
diff --git a/...ference/koswat_docstrings/calculations/reinforcement_profile_builder_factory.md b/...ference/koswat_docstrings/calculations/reinforcement_profile_builder_factory.md
diff --git a/docs/reference/koswat_docstrings/dike_reinforcements/reinforcement_layers.md b/docs/reference/koswat_docstrings/dike_reinforcements/reinforcement_layers.md
@@ -0,0 +1,9 @@
+# Reinforcement Layers Wrapper
+
+::: koswat.dike_reinforcements.reinforcement_layers.reinforcement_layer_protocol
+::: koswat.dike_reinforcements.reinforcement_layers.reinforcement_base_layer
+::: koswat.dike_reinforcements.reinforcement_layers.reinforcement_coating_layer
+::: koswat.dike_reinforcements.reinforcement_layers.reinforcement_layers_wrapper
+
+::: koswat.dike_reinforcements.reinforcement_layers.outside_slope_reinforcement_layers_wrapper_builder
+::: koswat.dike_reinforcements.reinforcement_layers.standard_reinforcement_layers_wrapper_builder
diff --git a/docs/reference/koswat_docstrings/dike_reinforcements/reinforcement_profile.md b/docs/reference/koswat_docstrings/dike_reinforcements/reinforcement_profile.md
@@ -0,0 +1,22 @@
+# Reinforcement profile
+
+::: koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_builder_base
+::: koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_builder_factory
+::: koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_builder_protocol
+::: koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_protocol
+::: koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile
+
+## Outside slope
+
+::: koswat.dike_reinforcements.reinforcement_profile.outside_slope.cofferdam_reinforcement_profile
+::: koswat.dike_reinforcements.reinforcement_profile.outside_slope.outside_slope_reinforcement_profile_builder
+::: koswat.dike_reinforcements.reinforcement_profile.outside_slope.outside_slope_reinforcement_profile
+
+
+## Standard
+
+::: koswat.dike_reinforcements.reinforcement_profile.standard.piping_wall_reinforcement_profile
+::: koswat.dike_reinforcements.reinforcement_profile.standard.soil_reinforcement_profile
+::: koswat.dike_reinforcements.reinforcement_profile.standard.stability_wall_reinforcement_profile
+::: koswat.dike_reinforcements.reinforcement_profile.standard.standard_reinforcement_profile
+::: koswat.dike_reinforcements.reinforcement_profile.standard.standard_reinforcement_profile_builder
diff --git a/docs/user_manual.md b/docs/user_manual.md
@@ -34,7 +34,7 @@ from koswat.configuration.settings.koswat_run_scenario_settings import (
 from koswat.cost_report.io.plots.multi_location_profile_comparison_plot_exporter import (
     MultiLocationProfileComparisonPlotExporter,
 )
-from koswat.calculations import ReinforcementProfileBuilderFactory
+from koswat.dike_reinforcements import ReinforcementProfileBuilderFactory
 
 # 1. Define input data.
 _input_dir = Path("C:\\my_koswat_input_dir")

diff --git a/koswat/calculations/__init__.py b/koswat/calculations/__init__.py
diff --git a/koswat/calculations/outside_slope_reinforcement/__init__.py b/koswat/calculations/outside_slope_reinforcement/__init__.py
diff --git a/koswat/calculations/outside_slope_reinforcement/cofferdam/__init__.py b/koswat/calculations/outside_slope_reinforcement/cofferdam/__init__.py
diff --git a/koswat/calculations/outside_slope_reinforcement/cofferdam/cofferdam_reinforcement_profile.py b/koswat/calculations/outside_slope_reinforcement/cofferdam/cofferdam_reinforcement_profile.py
diff --git a/koswat/calculations/outside_slope_reinforcement/outside_slope_reinforcement_profile.py b/koswat/calculations/outside_slope_reinforcement/outside_slope_reinforcement_profile.py
diff --git a/koswat/calculations/protocols/README.md b/koswat/calculations/protocols/README.md
diff --git a/koswat/calculations/protocols/__init__.py b/koswat/calculations/protocols/__init__.py
diff --git a/koswat/calculations/protocols/reinforcement_input_profile_protocol.py b/koswat/calculations/protocols/reinforcement_input_profile_protocol.py
diff --git a/koswat/calculations/standard_reinforcement/__init__.py b/koswat/calculations/standard_reinforcement/__init__.py
diff --git a/koswat/calculations/standard_reinforcement/piping_wall/__init__.py b/koswat/calculations/standard_reinforcement/piping_wall/__init__.py
diff --git a/koswat/calculations/standard_reinforcement/piping_wall/piping_wall_reinforcement_profile.py b/koswat/calculations/standard_reinforcement/piping_wall/piping_wall_reinforcement_profile.py
diff --git a/koswat/calculations/standard_reinforcement/soil/__init__.py b/koswat/calculations/standard_reinforcement/soil/__init__.py
diff --git a/koswat/calculations/standard_reinforcement/soil/soil_input_profile.py b/koswat/calculations/standard_reinforcement/soil/soil_input_profile.py
diff --git a/koswat/calculations/standard_reinforcement/soil/soil_reinforcement_profile.py b/koswat/calculations/standard_reinforcement/soil/soil_reinforcement_profile.py
diff --git a/koswat/calculations/standard_reinforcement/stability_wall/__init__.py b/koswat/calculations/standard_reinforcement/stability_wall/__init__.py
diff --git a/koswat/calculations/standard_reinforcement/stability_wall/stability_wall_input_profile.py b/koswat/calculations/standard_reinforcement/stability_wall/stability_wall_input_profile.py
diff --git a/...alculations/standard_reinforcement/stability_wall/stability_wall_reinforcement_profile.py b/...alculations/standard_reinforcement/stability_wall/stability_wall_reinforcement_profile.py
diff --git a/koswat/calculations/standard_reinforcement/standard_reinforcement_profile.py b/koswat/calculations/standard_reinforcement/standard_reinforcement_profile.py
diff --git a/koswat/cost_report/io/plots/multi_location_profile_comparison_plot_exporter.py b/koswat/cost_report/io/plots/multi_location_profile_comparison_plot_exporter.py
@@ -1,9 +1,9 @@
 from pathlib import Path
 
-from koswat.calculations.io.reinforced_profile_comparison_plot_exporter import (
+from koswat.dike_reinforcements.io.reinforced_profile_comparison_plot_exporter import (
     ReinforcedProfileComparisonPlotExporter,
 )
-from koswat.calculations.io.reinforced_profile_plot_exporter import (
+from koswat.dike_reinforcements.io.reinforced_profile_plot_exporter import (
     ReinforcedProfilePlotExporter,
 )
 from koswat.cost_report.multi_location_profile.multi_location_profile_cost_report import (

diff --git a/koswat/cost_report/multi_location_profile/multi_location_profile_cost_builder.py b/koswat/cost_report/multi_location_profile/multi_location_profile_cost_builder.py
@@ -1,4 +1,6 @@
-from koswat.calculations.protocols import ReinforcementProfileProtocol
+from koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_protocol import (
+    ReinforcementProfileProtocol,
+)
 from koswat.configuration.settings.costs.koswat_costs import KoswatCostsSettings
 from koswat.core.protocols import BuilderProtocol
 from koswat.cost_report.multi_location_profile.multi_location_profile_cost_report import (

diff --git a/koswat/cost_report/profile/layer_cost_report.py b/koswat/cost_report/profile/layer_cost_report.py
@@ -2,7 +2,7 @@
 
 import math
 
-from koswat.calculations.reinforcement_layers.reinforcement_layer_protocol import (
+from koswat.dike_reinforcements.reinforcement_layers.reinforcement_layer_protocol import (
     ReinforcementLayerProtocol,
 )
 from koswat.cost_report.cost_report_protocol import CostReportProtocol

diff --git a/koswat/cost_report/profile/profile_cost_report.py b/koswat/cost_report/profile/profile_cost_report.py
@@ -3,7 +3,9 @@
 import math
 from typing import List
 
-from koswat.calculations.protocols import ReinforcementProfileProtocol
+from koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_protocol import (
+    ReinforcementProfileProtocol,
+)
 from koswat.cost_report.cost_report_protocol import CostReportProtocol
 from koswat.cost_report.profile.layer_cost_report import LayerCostReport
 from koswat.cost_report.profile.volume_cost_parameters import VolumeCostParameters

diff --git a/koswat/cost_report/profile/profile_cost_report_builder.py b/koswat/cost_report/profile/profile_cost_report_builder.py
@@ -1,6 +1,8 @@
 from typing import List
 
-from koswat.calculations.protocols import ReinforcementProfileProtocol
+from koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_protocol import (
+    ReinforcementProfileProtocol,
+)
 from koswat.configuration.settings.costs.koswat_costs import KoswatCostsSettings
 from koswat.core.protocols import BuilderProtocol
 from koswat.cost_report.profile.layer_cost_report import LayerCostReport

diff --git a/koswat/cost_report/profile/volume_cost_parameters.py b/koswat/cost_report/profile/volume_cost_parameters.py
@@ -3,7 +3,9 @@
 import math
 from typing import List, Tuple
 
-from koswat.calculations.protocols import ReinforcementProfileProtocol
+from koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_protocol import (
+    ReinforcementProfileProtocol,
+)
 from koswat.cost_report.profile.volume_cost_parameters_calculator import (
     VolumeCostParametersCalculator,
 )

diff --git a/koswat/cost_report/profile/volume_cost_parameters_builder.py b/koswat/cost_report/profile/volume_cost_parameters_builder.py
@@ -1,7 +1,9 @@
 import logging
 from typing import Union
 
-from koswat.calculations.protocols import ReinforcementProfileProtocol
+from koswat.dike_reinforcements.reinforcement_profile.reinforcement_profile_protocol import (
+    ReinforcementProfileProtocol,
+)
 from koswat.configuration.settings.costs.dike_profile_costs_settings import (
     DikeProfileCostsSettings,
 )