FreeFemResultParser#

class zeroheliumkit.fem.fieldreader.FreeFemResultParser(metadata_file: str, show: bool = True)[source]#

Bases: object

Parses and loads results from FreeFem simulations using metadata and data files.

Parameters:

metadata_file (str) – Path to the YAML metadata file containing simulation information.

Methods

get_capacitance_matrix()

Returns the capacitance matrix from the metadata.

get_coupling_constants(slice_value[, ...])

Returns the coupling constants at a specific slice value and rounds the data to the specified number of decimal places.

load_data(savedir, fname)

Loads electrode field data from a Parquet file and organizes it into a structured dictionary.

print_table()

Prints a formatted table of selected metadata attributes using the tabulate library.

Attributes

metadata

data

print_table()[source]#

Prints a formatted table of selected metadata attributes using the tabulate library.

load_data(savedir: str, fname: str)[source]#

Loads electrode field data from a Parquet file and organizes it into a structured dictionary.

Parameters:
  • savedir (str) – Directory path where the Parquet file is stored.

  • fname (str) – Base filename (without extension) of the Parquet file to load.

get_coupling_constants(slice_value: float, round_with_decimals: int = 6) CouplingConstants[source]#

Returns the coupling constants at a specific slice value and rounds the data to the specified number of decimal places.

get_capacitance_matrix()[source]#

Returns the capacitance matrix from the metadata.