io_tools package

io_tools.examples

io_tools.examples.load_example(example: str) → Simulation[source]

Load one of the examples and create a Simulation object with default simulation parameters.

Parameters:: example (str) – Number of the example to load, e.g. ‘01’, ‘02’, etc.
Returns:: Simulation object
Return type:: Simulation

io_tools.expot_cad

io_tools.export_cad.export_cad(sim: Simulation, path: str)[source]

This function is still in BETA state. It exports the resonator geometry and aperture to a CAD file.

Parameters:

sim (Simulation) – Simulation object containing the resonator geometry and aperture.
path (str) – path to save the CAD file.

io_tools.load_from_json

io_tools.load_from_json.load_from_json(file_path) → Simulation[source]

Load Simulation from JSON file.

Parameters:: file_path (str) – file path to the JSON file.
Returns:: Simulation object with loaded data.
Return type:: Simulation

io_tools.save_to_json

io_tools.save_to_json.save_to_json(simulation: Simulation, file_path: str) → None[source]

Save Simulation to JSON file.

Parameters:

simulation (Simulation) – Simulation object to save.
file_path (str) – file path to save the JSON file.

Module contents