pyleecan.Classes.VarParam module

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Simulation/VarParam

class VarParam(paramexplorer_list=- 1, name='', desc='', datakeeper_list=- 1, is_keep_all_output=False, stop_if_error=False, var_simu=None, nb_simu=0, is_reuse_femm_file=True, postproc_list=- 1, pre_keeper_postproc_list=None, post_keeper_postproc_list=None, is_reuse_LUT=True, init_dict=None, init_str=None)[source]

Bases: VarSimu

Handle multisimulation by varying parameters

VERSION = 1
NAME = 'Parameter Sweep'
check_param()

Check VarParam parameters validity

Raises:
  • ParamExplorerError – Error in ParamExplorer setting:

  • VarParamError – Error in VarParam general setting:

  • DataKeeperError – Error in DataKeeper setting:

generate_simulation_list(ref_simu=None)

Generate all the simulation for the multi-simulation

Parameters:
  • self (VarSimu) – A VarSimu object

  • ref_simu (Simulation) – Reference simulation to copy / update

Returns:

multisim_dict – dictionary containing the simulation and paramexplorer list

Return type:

dict

get_simu_number()

Return the number of simulation defined by the Param Explorer

Parameters:

self (VarParam) – A VarParam object

Returns:

nb_simu – number of simulation

Return type:

int

save(save_path='', is_folder=False, type_handle_old=2, type_compression=0)

Save the object to the save_path

Parameters:
  • self – A pyleecan object

  • save_path (str) – path to the folder to save the object

  • is_folder (bool) – to split the object in different files: separate simulation machine and materials (json only)

  • type_handle_old (int) – How to handle old file in folder mode (0:Nothing, 1:Delete, 2:Move to “Backup” folder)

  • type_compression (int) – Available only for json, 0: no compression, 1: gzip

get_logger()

Get the object logger or its parent’s one

Parameters:

obj – A pyleecan object

Returns:

logger – Pyleecan object dedicated logger

Return type:

logging.Logger

compare(other, name='self', ignore_list=None, is_add_value=False)[source]

Compare two objects and return list of differences

as_dict(type_handle_ndarray=0, keep_function=False, **kwargs)[source]

Convert this object in a json serializable dict (can be use in __init__). type_handle_ndarray: int

How to handle ndarray (0: tolist, 1: copy, 2: nothing)

keep_functionbool

True to keep the function object, else return str

Optional keyword input parameter is for internal use only and may prevent json serializability.

copy()[source]

Creates a deepcopy of the object

property paramexplorer_list

List containing ParamSetter to define every simulation

Type:

[ParamExplorer]