Source code for kqcircuits.simulations.export.export_and_run

# This code is part of KQCircuits
# Copyright (C) 2023 IQM Finland Oy
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# The software distribution should follow IQM trademark policy for open-source software
# (meetiqm.com/developers/osstmpolicy). IQM welcomes contributions to the code. Please see our contribution agreements
# for individuals (meetiqm.com/developers/clas/individual) and organizations (meetiqm.com/developers/clas/organization).
from pathlib import Path
import subprocess
import platform
import sys
import logging

logging.basicConfig(level=logging.WARN, stream=sys.stdout)


[docs]def export_and_run(export_script: Path, export_path: Path, quiet: bool = False, export_only: bool = False, args=None): """ Exports and runs a KQC simulation. Args: export_script(Path): path to the simulation export script export_path(Path): path where simulation files are exported quiet(bool): if True all the GUI dialogs are shown, otherwise not. export_only(bool): if True no simulation is run, only export files. args(list): a list of strings describing arguments to be passed to the simulation script Returns: a tuple containing * export_script(Path): path to the simulation export script * export_path(Path): path where simulation files are exported """ if args is None: args = [] else: if "--simulation-export-path" in args: logging.error("--simulation-export-path is not allowed!") sys.exit() subprocess.call( [sys.executable, export_script, "--simulation-export-path", str(export_path)] + args + (["-q"] if quiet else []) ) if export_only: return export_script, export_path if (export_path / "simulation.sh").is_file(): if platform.system() == "Darwin": # macOS subprocess.call(["bash", "simulation.sh"], cwd=str(export_path)) else: # Linux subprocess.call(["bash", "simulation.sh"], cwd=str(export_path)) else: if platform.system() == "Windows": # Windows subprocess.call("simulation.bat", shell=True, cwd=str(export_path)) return export_script, export_path