header_str

mdtools.file_handler.header_str()

Create a standard header string for text files.

The string can be printed directly to standard output using print().

The header string contains:

• The date and time the text file was created (actually this function was called).

• The MDTools copyright notice.

• The information generated by mdtools.run_time_info.run_time_info().

Returns:

header (str) – Human readable string containing the above listed content.

See also

mdtools.run_time_info.run_time_info()

Generate some run time information

mdtools.run_time_info.run_time_info_str()

Create a string containing some run time information