#############################################################################
# Chama Optimization Configuration File (YAML). #
# #############################################################################
# 1. Plume Generation
# ------------------------------------------------------------------------------
# standard_deviations: Specifies the length and width parameters for the plume
# release, influencing its dispersion characteristics.
# wind_direction_degree: Represents the 360-degree orientation of the wind,
# indicating the direction in which it blows.
# contaminant_size_in_picocurie: Quantifies the amount of contaminant released
# in picocuries.
# ------------------------------------------------------------------------------
# ------------------------------------------------------------------------------
# 2. Network File information
# ------------------------------------------------------------------------------
# inp_file: The foundational inp file which serves as the basis for generating
# all subsequent inp files.
# start_plume_objects: Identifies the SWMM objects at which plumes can originate.
# subcatchments_centers_file: Contains the centroid coordinates (x and y) of
# subcatchments, serving as pollutant release points.
# rainfall_metadata_file: Specifies the start and end times of the rainfall event.
# sensor_objects: Designates locations for sensors to capture relevant data.
# Rainfall_Hotstart_filenames: The names of the Rainfall and Hotstart files for
# PySWMM. NOTE that we are currently naming the
# Rainfall and Hotstart files the same.
# ------------------------------------------------------------------------------
# ------------------------------------------------------------------------------
# 3. Paths: List of local input and output paths for the simulation. These
# generally will not change.
# ------------------------------------------------------------------------------
# input: Location of the static ensemble inputs.
# inp_output: Location where generated inp files are written.
# rainfall_hotstart_input: Location of the static rainfall and hotstart files.
# signal_output: Location of the generated signal files.
# database_dir: Location of the SQLite Database.
# output_dir: Location where the chama output files are generated.
# ------------------------------------------------------------------------------
# ------------------------------------------------------------------------------
# 4. INP file information
# ------------------------------------------------------------------------------
# pollutant: Specifies the nature or category of the pollutant under
# consideration.
# reporting_time_in_min: SWMM reports data at regular intervals, with a
# frequency in minutes.
# sim_timestep_window_in_sec: Defines the simulation timestep, with a frequency
# in seconds.
# multi_inp_files: Specifies whether the process involves multiple signals or a
# single signal file.
# swmm_start_time: Indicates the specific time at which the simulation began.
# reporting_time: Specifies the time intervals at which SWMM generates reports
# during a simulation.
# max_concurrent_processes: It limits how many processes are spawned inside the code.
# Each process is one instance of pyswmm simulation
# ------------------------------------------------------------------------------
# ------------------------------------------------------------------------------
# 5. Chama Optimization
# ------------------------------------------------------------------------------
# model_name: Identifies the specific model name associated with a network.
# time_step: Specifies the timestep used in the Chama model for computations
# and analyses.
# start_step: Indicates the starting point of the Chama run.
# end_step: Specifies the last step for the Chama run, defining the
# duration of the simulation.
# detector_threshold: Establishes the minimum pollutant concentration required
# for successful detection.
# sensor_budget: Quantifies the number of sensors available for monitoring
# within the Chama model.
# formulation: Describes the formulation method employed in the Chama model for
# pollutant analysis.
# opt_approach: Outlines the optimization strategy utilized within the Chama
# framework.
# undetected_impact: This parameter reflects the penalty associated with
# failing to detect pollutants.
# ------------------------------------------------------------------------------
# ------------------------------------------------------------------------------
# 6. Flags
# ------------------------------------------------------------------------------
# single_out_rpt_files: This flag controls whether the code deletes the output and report
# files generated by the pyswmm module after execution.
# single_signal_files: This flag probably determines whether the code deletes signal
# files associated with each pyswmm run.
# entity_assessment_flag: A flag in the code that logs the entity assessment from the chama coverage fomulation.
# sensor_assessment_flag: A flag in the code that logs the sensor assessment from the chama coverage fomulation.
# ------------------------------------------------------------------------------