Skip to content

DataSettings

Auto-generated documentation for DataSettings.

Classes

Condor

Module: DataSettings

Description: Class for running using HTCondor queuing (only on Linux)

Fields

Field Type Default Description
error Optional[str] null Error file name and extension, like error.txt
output Optional[str] null Output file name and extension, like output.txt
log Optional[str] null Log file name and extension, like log.txt
request_cpus Optional[int] null Number of CPUs to request on each machine
request_memory Optional[str] null Amount of memory to request on each machine as a string (e.g., '16G')
request_disk Optional[str] null Amount of disk space to request on each machine as a string (e.g., '16G')
singularity_image_path Optional[str] null Full path to Singularity image
cerngetdp_version Optional[str] null Version of CERNGetDP to be used
should_transfer_files Literal[str] "YES" Sets if files should be transferred

Available inputs: "YES", "NO"
max_run_time Optional[int] null Specifies maximum run time in seconds to request for the job to go into the queue
eos_relative_output_path Optional[str] null This is relative path in the user eos folder. This path gets appended to the root path: root://eosuser.cern.ch//eos/user/u/username
big_mem_job Optional[bool] null If true a machine with 1TB of RAM and 24 cores is requested. Expect longer queuing time

DataSettings

Module: DataSettings

Description: Configuration for HTCondor and

Fields

Field Type Default Description
GetDP_path Optional[str] null Full path to GetDP executable. This is only needed and used on Windows
base_path_model_files Optional[str] null Path to the base model folder where model files are stored that are needed to run FiQuS.This is only needed when the files are not in the same folder as the input yaml (e.g., on HTCondor)
htcondor Condor Condor()
subproc Subproc Subproc()

Nested Models

Condor

Description: Class for running using HTCondor queuing (only on Linux)

Field Type Default Description
error Optional[str] null Error file name and extension, like error.txt
output Optional[str] null Output file name and extension, like output.txt
log Optional[str] null Log file name and extension, like log.txt
request_cpus Optional[int] null Number of CPUs to request on each machine
request_memory Optional[str] null Amount of memory to request on each machine as a string (e.g., '16G')
request_disk Optional[str] null Amount of disk space to request on each machine as a string (e.g., '16G')
singularity_image_path Optional[str] null Full path to Singularity image
cerngetdp_version Optional[str] null Version of CERNGetDP to be used
should_transfer_files Literal[str] "YES" Sets if files should be transferred

Available inputs: "YES", "NO"
max_run_time Optional[int] null Specifies maximum run time in seconds to request for the job to go into the queue
eos_relative_output_path Optional[str] null This is relative path in the user eos folder. This path gets appended to the root path: root://eosuser.cern.ch//eos/user/u/username
big_mem_job Optional[bool] null If true a machine with 1TB of RAM and 24 cores is requested. Expect longer queuing time

Subproc

Description: Class for running using subprocess calls (on Windows)

Field Type Default Description
executable Optional[str] null Executable or script to run, like run_fiqus.py
full_output_path Optional[str] null A full path to the output folder

Subproc

Module: DataSettings

Description: Class for running using subprocess calls (on Windows)

Fields

Field Type Default Description
executable Optional[str] null Executable or script to run, like run_fiqus.py
full_output_path Optional[str] null A full path to the output folder