S5.HPC.SolarSim.file_sweep_par#

S5.HPC.SolarSim.file_sweep_par(file_list: List[str | PathLike], run_name: str | PathLike, executable_location: str | PathLike = '../SolarSim.X', n_jobs: int = 2) → None[source]#

Run a sweep of SolarSim with the files specified.

Sweep files by renaming each of the file in list to run_name and run SolarSim. Block until last the SolarSim has finish read in.

Parameters:

  • file_list – filename to be swapped in for solarsim

  • run_name – name referenced in control file

  • executable_location – Path to SolarSim to execute.

  • n_jobs – Number of SolarSims to run in parallel, if less than 16 cpu (non-HPC) it will default to number of cpu - 2, else it will be the number of cpu available.

Returns:

None

See also

S5.SolarSim.file_swap : Run this function in serial. S5.SolarSim.read_file_sweep : Read the results of a file sweep.