diff --git a/README.md b/README.md index a982a4d1..13f9d698 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ pip install git+https://github.com/Deltares/Koswat.git@v0.11.0 1. With [Anaconda](https://www.anaconda.com/) (our recommendation): ```bash cd C:\repos\koswat - conda env create -f .conf\environment.yml + conda env create -f .config\environment.yml conda activate koswat_env poetry install ``` diff --git a/docs/reference/koswat_reinforced_profile.md b/docs/reference/koswat_reinforced_profile.md index 20b9f45e..0305702f 100644 --- a/docs/reference/koswat_reinforced_profile.md +++ b/docs/reference/koswat_reinforced_profile.md @@ -1,6 +1,6 @@ # Reinforcement profile -In koswat we consider a reinforcement profile that of a result of applying one of the multiple possible reinforcement calculations on an instance of a `KoswatProfileBase` ([Koswat dike](koswat_dike.md)). +In koswat we consider a reinforcement profile the result of applying one of the multiple possible reinforcement calculations on an instance of a `KoswatProfileBase` ([Koswat dike](koswat_dike.md)). This chapter covers the description of a reinforcement profile and its parts. diff --git a/koswat/calculations/protocols/reinforcement_profile_builder_protocol.py b/koswat/calculations/protocols/reinforcement_profile_builder_protocol.py index 31905e8e..13afc9c3 100644 --- a/koswat/calculations/protocols/reinforcement_profile_builder_protocol.py +++ b/koswat/calculations/protocols/reinforcement_profile_builder_protocol.py @@ -16,7 +16,7 @@ class ReinforcementProfileBuilderProtocol(BuilderProtocol, Protocol): def build(self) -> ReinforcementProfileProtocol: """ - Builds a concrete instance of a `ReinforcementProfileProtocol` base don the required data. + Builds a concrete instance of a `ReinforcementProfileProtocol` based on the required data. Returns: ReinforcementProfileProtocol: Valid instance of a `ReinforcementProfileProtocol`. diff --git a/koswat/koswat_handler.py b/koswat/koswat_handler.py index 44feebd8..d27a7f85 100644 --- a/koswat/koswat_handler.py +++ b/koswat/koswat_handler.py @@ -87,7 +87,7 @@ def run_analysis(self, analysis_file: str) -> None: Runs a Koswat analysis using the provided `*.ini` file `analysis_file`. Args: - analysis_file (str): Location of the main koswat analisis ini file. + analysis_file (str): Location of the main koswat analysis ini file. """ def _as_path(ini_file: str) -> Optional[Path]: