NikolajDanger/meow_base
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added comment to parameter sweep function

Browse Source
This commit is contained in:
PatchOfScotland
2023-02-11 23:51:23 +01:00
parent 7dd654bb8c
commit 6d92ce9fdb
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
functionality/meow.py
View File

@ -64,6 +64,10 @@ def replace_keywords(old_dict:Dict[str,str], job_id:str, src_path:str,
def create_parameter_sweep(variable_name:str, start:Union[int,float,complex], def create_parameter_sweep(variable_name:str, start:Union[int,float,complex],
stop:Union[int,float,complex], jump:Union[int,float,complex] stop:Union[int,float,complex], jump:Union[int,float,complex]
)->Dict[str,Dict[str,Union[int,float,complex]]]: )->Dict[str,Dict[str,Union[int,float,complex]]]:
"""Function to create a valid parameter sweep dict for a givan variable,
from start to stop, with a regular jump of jump. This function will perform
some basic checks to ensure this isn't infinitie in nature as that
would lead to unlimited jobs scheduled per event."""
check_type(variable_name, str, hint="create_parameter_sweep.variable_name") check_type(variable_name, str, hint="create_parameter_sweep.variable_name")
check_type(start, int, alt_types=[float, complex]) check_type(start, int, alt_types=[float, complex])
check_type(stop, int, alt_types=[float, complex]) check_type(stop, int, alt_types=[float, complex])