S5.HPC.SolarSim.file_swap#

S5.HPC.SolarSim.file_swap(lock: Lock, filename: str | PathLike, run_name: str | PathLike, executable_location: str | PathLike, control: str | PathLike, summary: str | PathLike, history: str | PathLike, solartotals: str | PathLike) → None[source]#

Swap file in and run SolarSim with it.

This function will take a copy of the file specified by filename and rename it to run_name. To use this function the control file entry for the corresponding file should be the same as run_name.

Parameters:

  • lock – multiprocessing.Lock for parallel computing

  • filename – Filename to be swapped in for solarsim

  • run_name – Name in the control file.

  • executable_location – Path to SolarSim to execute.

  • control – Pth to control file.

  • summary – Path to write summary file.

  • history – Path to write history file.

  • solartotals – Path to write solartotals file.

Returns:

None

See also

S5.SolarSim.file_swap_par : Run this function in parallel.