rdf_output_file_writer

A module containing the classes for writing related to an RDF analysis to a file.

Summary

Classes:

RDFDataWriter	Class for writing the data of an RDF analysis to a file.
RDFLogWriter	Class for writing the log (setup parameters) of an RDF analysis to a file.

Reference

class RDFDataWriter(filename: str)

Bases: BaseWriter

Class for writing the data of an RDF analysis to a file.

Parameters:

filename (str) – the filename to write to

write(

data: tuple[Np1DNumberArray, Np1DNumberArray, Np1DNumberArray, Np1DNumberArray, Np1DNumberArray],

)

Writes the data to the file.

Parameters:

data (Tuple[Np1DNumberArray, Np1DNumberArray,) – Np1DNumberArray, Np1DNumberArray, Np1DNumberArray] the data output from the RadialDistributionFunction.run() method

class RDFLogWriter(filename: str | None)

Bases: BaseWriter

Class for writing the log (setup parameters) of an RDF analysis to a file.

Parameters:

filename (str | None) – the filename to write to if None, the output is printed to stdout

write_after_run(

rdf: RDF,

)

Writes the log after the RDF run() method is called.

This includes the elapsed time of the RDF run() method.

Parameters:

rdf (RadialDistributionFunction) – the RDF analysis object

write_before_run(

rdf: RDF,

)

Writes the log before the RDF run() method is called.

This includes the general header of PQAnalysis and the most important setup parameters of the RDF analysis.

Parameters:

rdf (RadialDistributionFunction) – the RDF analysis object