quvac.simulation

Script to launch Vacuum Emission simulation, do postprocessing and measure performance.

Usage:

python simulation.py -i <input>.yml -o <output_dir> --wisdom <wisdom_file>

Functions

parse_args([description])

Parse command-line arguments.

check_dirs(ini_file, save_path)

Check if directories exist and create them if necessary.

get_filenames(ini_file, save_path, wisdom_file[, mode])

Get filenames for saving simulation data.

get_dirs(ini_file, save_path, wisdom_file[, mode])

Get directories for saving simulation data.

set_precision(precision)

Set global precision for calculations.

create_basic_logger(filename)

run_simulation(ini_config, fields_params, files, ...)

Run the vacuum emission simulation.

postprocess_simulation(ini_config, files, fields_params)

Perform postprocessing on the simulation data.

quvac_simulation(ini_file[, save_path, wisdom_file])

Launch a single quvac simulation for given <ini>.yml file.

main_simulation()

Main function to run the simulation script.

Module Contents

quvac.simulation.parse_args(description='Calculate quantum vacuum signal for external fields.')[source]

Parse command-line arguments.

Returns:

Parsed command-line arguments.

Return type:

argparse.Namespace

quvac.simulation.check_dirs(ini_file, save_path)[source]

Check if directories exist and create them if necessary.

Parameters:
  • ini_file (str) – Path to the initialization file.

  • save_path (str) – Path to save the results.

Returns:

save_path – Validated save path.

Return type:

str

quvac.simulation.get_filenames(ini_file, save_path, wisdom_file, mode=None)[source]

Get filenames for saving simulation data.

Parameters:
  • ini_file (str) – Path to the initialization file.

  • save_path (str) – Path to save the results.

  • wisdom_file (str) – Path to save pyfftw-wisdom.

Returns:

files – Dictionary containing filenames for saving simulation data.

Return type:

dict

quvac.simulation.get_dirs(ini_file, save_path, wisdom_file, mode=None)[source]

Get directories for saving simulation data.

Parameters:
  • ini_file (str) – Path to the initialization file.

  • save_path (str) – Path to save the results.

  • wisdom_file (str) – Path to save pyfftw-wisdom.

Returns:

files – Dictionary containing directories for saving simulation data.

Return type:

dict

quvac.simulation.set_precision(precision)[source]

Set global precision for calculations.

Parameters:

precision (str) – Precision type, either “float32” or “float64”.

quvac.simulation.create_basic_logger(filename)[source]
quvac.simulation.run_simulation(ini_config, fields_params, files, timings, memory)[source]

Run the vacuum emission simulation.

Parameters:
  • ini_config (dict) – Dictionary containing the initialization configuration.

  • fields_params (list of dict) – List of dictionaries containing the field parameters.

  • files (dict) – Dictionary containing filenames for saving simulation data.

  • timings (dict) – Dictionary to store timing information.

  • memory (dict) – Dictionary to store memory usage information.

Returns:

  • timings (dict) – Updated dictionary with timing information.

  • memory (dict) – Updated dictionary with memory usage information.

quvac.simulation.postprocess_simulation(ini_config, files, fields_params)[source]

Perform postprocessing on the simulation data.

Parameters:
  • ini_config (dict) – Dictionary containing the initialization configuration.

  • files (dict) – Dictionary containing filenames for saving simulation data.

  • fields_params (list of dict) – List of dictionaries containing the field parameters.

quvac.simulation.quvac_simulation(ini_file, save_path=None, wisdom_file='wisdom/fftw-wisdom')[source]

Launch a single quvac simulation for given <ini>.yml file.

Parameters:
  • ini_file (str) – Path to the initialization file.

  • save_path (str, optional) – Path to save simulation results to, by default None.

  • wisdom_file (str, optional) – Path to save pyfftw-wisdom, by default “wisdom/fftw-wisdom”.

quvac.simulation.main_simulation()[source]

Main function to run the simulation script.