process_output

Handles writing output to PROCESS MFile/OUTFile.

OutputFileManager

Manages the opening of regular/idempotence output files.

Source code in process/core/process_output.py

class OutputFileManager:
    """Manages the opening of regular/idempotence output files."""

    @classmethod
    def open_files(cls, output_prefix: str, *, mode="w"):
        """Setup the handlers for MFile and OUTFile for writing."""
        cls._outfile = open(  # noqa: SIM115
            Path(output_prefix + "OUT.DAT"), mode
        )
        cls._mfile = open(  # noqa: SIM115
            Path(output_prefix + "MFILE.DAT"), mode
        )

    @classmethod
    def open_idempotence_files(cls, output_prefix: str):
        """Setup the handlers for idempotence MFile and OUTFile for writing."""
        cls._outfile.close()
        cls._mfile.close()

        cls._outfile = open(  # noqa: SIM115
            Path(output_prefix + "IDEM_OUT.DAT"), "w"
        )
        cls._mfile = open(  # noqa: SIM115
            Path(output_prefix + "IDEM_MFILE.DAT"), "w"
        )

    @classmethod
    def close_idempotence_files(cls, output_prefix: str):
        """Removes idempotence output files, closes the handler,
        and opens the main output files.
        """
        Path(cls._outfile.name).unlink()
        Path(cls._mfile.name).unlink()
        cls._outfile.close()
        cls._mfile.close()
        cls.open_files(mode="a", output_prefix=output_prefix)

    @classmethod
    def finish(cls):
        """Closes the file handlers."""
        cls._outfile.close()
        cls._mfile.close()

open_files(output_prefix, *, mode='w') classmethod

Setup the handlers for MFile and OUTFile for writing.

Source code in process/core/process_output.py

@classmethod
def open_files(cls, output_prefix: str, *, mode="w"):
    """Setup the handlers for MFile and OUTFile for writing."""
    cls._outfile = open(  # noqa: SIM115
        Path(output_prefix + "OUT.DAT"), mode
    )
    cls._mfile = open(  # noqa: SIM115
        Path(output_prefix + "MFILE.DAT"), mode
    )

open_idempotence_files(output_prefix) classmethod

Setup the handlers for idempotence MFile and OUTFile for writing.

Source code in process/core/process_output.py

@classmethod
def open_idempotence_files(cls, output_prefix: str):
    """Setup the handlers for idempotence MFile and OUTFile for writing."""
    cls._outfile.close()
    cls._mfile.close()

    cls._outfile = open(  # noqa: SIM115
        Path(output_prefix + "IDEM_OUT.DAT"), "w"
    )
    cls._mfile = open(  # noqa: SIM115
        Path(output_prefix + "IDEM_MFILE.DAT"), "w"
    )

close_idempotence_files(output_prefix) classmethod

Removes idempotence output files, closes the handler, and opens the main output files.

Source code in process/core/process_output.py

@classmethod
def close_idempotence_files(cls, output_prefix: str):
    """Removes idempotence output files, closes the handler,
    and opens the main output files.
    """
    Path(cls._outfile.name).unlink()
    Path(cls._mfile.name).unlink()
    cls._outfile.close()
    cls._mfile.close()
    cls.open_files(mode="a", output_prefix=output_prefix)

finish() classmethod

Closes the file handlers.

Source code in process/core/process_output.py

@classmethod
def finish(cls):
    """Closes the file handlers."""
    cls._outfile.close()
    cls._mfile.close()

write(file, string)

Writes a string to the given file identifier.

Raises:

Type	Description
ProcessValueError	The file is not recognised as an MFile, OUTFile, or terminal.

Source code in process/core/process_output.py

def write(file, string: str):
    """Writes a string to the given file identifier.

    Raises
    ------
    ProcessValueError
        The file is not recognised as an MFile, OUTFile, or terminal.
    """
    if file == constants.MFILE:
        OutputFileManager._mfile.write(f"{string}\n")
    elif file == constants.NOUT:
        OutputFileManager._outfile.write(f"{string}\n")
    elif file == constants.IOTTY:
        print(string)
    else:
        error_msg = f"Unknown file identifier {file}, it is not recognised as either an MFile, OUTFile, or terminal."
        raise ProcessValueError(error_msg)

ocentr(file, string, width, *, character='*')

Write a centred header within a line of characters to a file

Parameters:

Name	Type	Description	Default
file		the integer unit of the file	required
string	str	the heading text	required
width	int	the desired with of the header	required
character		the character to pad the heading with () (Default value = "")	'*'

Source code in process/core/process_output.py

def ocentr(file, string: str, width: int, *, character="*"):
    """Write a centred header within a line of characters to a file

    Parameters
    ----------
    file :
        the integer unit of the file
    string :
        the heading text
    width :
        the desired with of the header
    character :
        the character to pad the heading with (*) (Default value = "*")

    """
    write(file, f"{f' {string} ':{character}^{width}}")
    write(constants.MFILE, f"# {string} #")

ostars(file, width, *, character='*')

Write a line of characters to a file

Parameters:

Name	Type	Description	Default
file		the integer unit of the file	required
width	int	the desired with of the line	required
character		the character to fill the line with () (Default value = "")	'*'

Source code in process/core/process_output.py

def ostars(file, width: int, *, character="*"):
    """Write a line of characters to a file

    Parameters
    ----------
    file :
        the integer unit of the file
    width :
        the desired with of the line
    character :
        the character to fill the line with (*) (Default value = "*")

    """
    write(file, character * width)

oheadr(file, string, *, width=110, character='*')

Write a centred header within a line of characters between two blank lines

Parameters:

Name	Type	Description	Default
file		the integer unit of the file	required
string	str	the heading text	required
width	int	the desired with of the header	110
character		the character to pad the heading with () (Default value = "")	'*'

Source code in process/core/process_output.py

def oheadr(file, string: str, *, width: int = 110, character="*"):
    """Write a centred header within a line of characters between two blank lines

    Parameters
    ----------
    file :
        the integer unit of the file
    string :
        the heading text
    width :
        the desired with of the header
    character :
        the character to pad the heading with (*) (Default value = "*")
    """
    oblnkl(file)
    ocentr(file, string, width, character=character)
    oblnkl(file)

oshead(file, string, *, width=80, character='*')

Write a short centred header within a line of characters between two blank lines

Parameters:

Name	Type	Description	Default
file		the integer unit of the file	required
string	str	the heading text	required
width	int	the desired with of the header	80
character		the character to pad the heading with () (Default value = "")	'*'

Source code in process/core/process_output.py

def oshead(file, string: str, *, width: int = 80, character="*"):
    """Write a short centred header within a line of characters between two blank lines

    Parameters
    ----------
    file :
        the integer unit of the file
    string :
        the heading text
    width :
        the desired with of the header
    character :
        the character to pad the heading with (*) (Default value = "*")
    """
    oheadr(file, string, width=width, character=character)

oblnkl(file)

Write a blank line to a file

Parameters:

Name	Type	Description	Default
file		the integer unit of the file	required

Source code in process/core/process_output.py

def oblnkl(file):
    """Write a blank line to a file

    Parameters
    ----------
    file :
        the integer unit of the file
    """
    write(file, " ")

osubhd(file, string)

Write a subheading between two blank lines

Parameters:

Name	Type	Description	Default
file		the integer unit of the file	required
string		the heading text	required

Source code in process/core/process_output.py

def osubhd(file, string):
    """Write a subheading between two blank lines

    Parameters
    ----------
    file :
        the integer unit of the file
    string :
        the heading text
    """
    oblnkl(file)
    write(file, string)
    oblnkl(file)

ocmmnt(file, string)

Write a comment to a file

Parameters:

Name	Type	Description	Default
file		the integer unit of the file	required
string	str	the comment text	required

Source code in process/core/process_output.py

def ocmmnt(file, string: str):
    """Write a comment to a file

    Parameters
    ----------
    file :
        the integer unit of the file
    string :
        the comment text
    """
    write(file, string)

ovarre(file, descr, varnam, value, output_flag='')

Write out a variable to a file via its identifier.

Source code in process/core/process_output.py

def ovarre(file, descr: str, varnam: str, value, output_flag: str = ""):
    """Write out a variable to a file via its identifier."""
    replacement_character = "_"
    if file != constants.MFILE:
        replacement_character = " "

    description = f"{descr:<72}".replace(" ", replacement_character)
    varname = f"{varnam:<30}".replace(" ", replacement_character)

    if isinstance(value, np.ndarray):
        value = value.item()
    if isinstance(value, str):
        # try and convert the value to a float
        # if it fails, leave as a string
        with suppress(ValueError):
            value = float(value)

    format_value = f"{value:.17e}" if isinstance(value, float) else f"{value: >12}"

    # TODO need to find a way to identify iteration variables at a higher level
    # in the data structure
    # if varnam.strip("()") in numerics.name_xc:
    #     # MDK add ITV label if it is an iteration variable
    #     # The ITV flag overwrites the output_flag
    #     output_flag = "ITV"

    line = f"{description}{replacement_character} {varname}{replacement_character} {format_value} {output_flag}"
    write(file, line)
    if file != constants.MFILE:
        ovarre(constants.MFILE, descr, varnam, value, output_flag)

ocosts(file, varnam, descr, value)

Source code in process/core/process_output.py

def ocosts(file, varnam: str, descr: str, value):
    ovarre(file, descr, varnam, value)

ovarrf(file, descr, varnam, value, output_flag='')

Source code in process/core/process_output.py

def ovarrf(file, descr: str, varnam: str, value, output_flag: str = ""):
    ovarre(file, descr, varnam, value, output_flag)

obuild(file, descr, thick, total, variable_name='')

Source code in process/core/process_output.py

def obuild(file, descr: str, thick: float, total: float, variable_name: str = ""):
    write(file, f"{descr:<50}{thick:.3e}{' ':<10}{total:.3e}  {variable_name}")