Skip to content

csv_output_handler

The CSV output handler.

This module defines the CSVOutputHandler class, which is responsible for writing samples to a CSV file. It's used by the Merlin job manager.

CSVOutputHandler

Bases: BaseOutputHandler

Output handler for writing samples to a CSV file.

Attributes:

Name Type Description
settings_class

The settings class for this output handler.
supported_kwargs

The full set of supported keyword arguments for the write method.
required_kwargs

The set of required keyword arguments for the write method.

Methods:

Name Description
write

Writes a list of samples to a CSV file.
Source code in src/mada_tools/simulation/simutils/samples/output/csv_output_handler.py 
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
class CSVOutputHandler(BaseOutputHandler):
    """
    Output handler for writing samples to a CSV file.

    Attributes:
        settings_class: The settings class for this output handler.
        supported_kwargs: The full set of supported keyword arguments for the `write` method.
        required_kwargs: The set of required keyword arguments for the `write` method.

    Methods:
        write: Writes a list of samples to a CSV file.
    """

    def _get_settings_class(self) -> CSVOutputSettings:
        """
        Get the settings class for this output handler.

        Returns:
            The settings class for this output handler.
        """
        return CSVOutputSettings

    def _get_supported_kwargs(self) -> Set[str]:
        """
        Get the set of supported keyword arguments for the `write` method.

        Returns:
            A set of supported keyword argument names for output configuration.
        """
        return {"output_file"}

    def _get_required_kwargs(self) -> Set[str]:
        """
        Get the set of required keyword arguments for the `write` method.

        Returns:
            A set of required keyword argument names for output configuration.
        """
        return {}

    def write(self, samples: np.ndarray, **kwargs: Dict[str, str]) -> SampleOutputResult:
        """
        Writes a list of samples to a CSV file.

        Args:
            samples: The samples to write, where each sample is a list of floats.
            **kwargs: Additional keyword arguments for output configuration. For CSV output, this must include:
                - output_file: The path to the CSV file where samples will be written.

        Returns:
            SampleOutputResult: A result object containing the output path and output type.
        """
        self.check_if_samples_are_empty(samples)

        output_settings = self.build_settings_from_kwargs(kwargs)

        print(f"Writing samples to '{output_settings.output_file}'...")
        with open(output_settings.output_file, "w") as outfile:
            writer = csv.writer(outfile)
            writer.writerows(samples)
        print("Samples written successfully.")

        return SampleOutputResult(output_path=output_settings.output_file, output_type="csv")

write(samples, **kwargs)

Writes a list of samples to a CSV file.

Parameters:

Name Type Description Default
samples ndarray

The samples to write, where each sample is a list of floats.

 required
**kwargs Dict[str, str]

Additional keyword arguments for output configuration. For CSV output, this must include: - output_file: The path to the CSV file where samples will be written.

 {}

Returns:

Name Type Description
SampleOutputResult SampleOutputResult

A result object containing the output path and output type.
Source code in src/mada_tools/simulation/simutils/samples/output/csv_output_handler.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def write(self, samples: np.ndarray, **kwargs: Dict[str, str]) -> SampleOutputResult:
    """
    Writes a list of samples to a CSV file.

    Args:
        samples: The samples to write, where each sample is a list of floats.
        **kwargs: Additional keyword arguments for output configuration. For CSV output, this must include:
            - output_file: The path to the CSV file where samples will be written.

    Returns:
        SampleOutputResult: A result object containing the output path and output type.
    """
    self.check_if_samples_are_empty(samples)

    output_settings = self.build_settings_from_kwargs(kwargs)

    print(f"Writing samples to '{output_settings.output_file}'...")
    with open(output_settings.output_file, "w") as outfile:
        writer = csv.writer(outfile)
        writer.writerows(samples)
    print("Samples written successfully.")

    return SampleOutputResult(output_path=output_settings.output_file, output_type="csv")

CSVOutputSettings dataclass

Bases: BaseSettings

A class to encapsulate the settings for how to output samples to a csv file.

This class is implemented to follow the common architecture used throughout the sample generation and output handling of the job management system. If more settings are needed, they can be added here easily.

Dataclasses like this help with type checking and setting defaults.

Attributes:

Name Type Description
output_file str

CSV file to save all samples (for csv mode).

Methods:

Name Description
validate

Validates the input settings.
__str__

Returns a string representation of the settings.
__repr__

Returns a detailed string representation of the settings.
Source code in src/mada_tools/simulation/simutils/samples/output/csv_output_handler.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@dataclass
class CSVOutputSettings(BaseSettings):
    """
    A class to encapsulate the settings for how to output samples to a csv file.

    This class is implemented to follow the common architecture used throughout the
    sample generation and output handling of the job management system. If more settings
    are needed, they can be added here easily.

    Dataclasses like this help with type checking and setting defaults.

    Attributes:
        output_file (str): CSV file to save all samples (for csv mode).

    Methods:
        validate: Validates the input settings.
        __str__: Returns a string representation of the settings.
        __repr__: Returns a detailed string representation of the settings.
    """

    output_file: str = "samples.csv"

    def validate(self):
        """
        Validates the input settings.
        """
        # Check if output_file is a string
        if not isinstance(self.output_file, str):
            raise TypeError("output_file must be a string")

validate()

Validates the input settings.

Source code in src/mada_tools/simulation/simutils/samples/output/csv_output_handler.py 
44
45
46
47
48
49
50
def validate(self):
    """
    Validates the input settings.
    """
    # Check if output_file is a string
    if not isinstance(self.output_file, str):
        raise TypeError("output_file must be a string")