Koswat handler

            GNU GENERAL PUBLIC LICENSE
              Version 3, 29 June 2007

KOSWAT, from the dutch combination of words Kosts-Wat (what are the costs) Copyright (C) 2025 Stichting Deltares

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

KoswatHandler

Handler for CLI usage of Koswat. It allows the initialization of a logger during the analysis.

__init__(log_output: Optional[str]) -> None

Initializes the handler creating a log file at the optional provided directory log_output.

Parameters:
  • log_output (Optional[str]) –

    Directory where to save the koswat.log file.

run_analysis(analysis_file: str) -> None

Runs a Koswat analysis using the provided *.json file analysis_file.

Parameters:
  • analysis_file (str) –

    Location of the main koswat analysis json file.