pyleecan.Classes.ImportMatrixXls module

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Import/ImportMatrixXls

class ImportMatrixXls(file_path='', sheet='', skiprows=0, usecols=None, axes_colrows=None, is_allsheets=False, is_transpose=False, init_dict=None, init_str=None)[source]

Bases: ImportMatrix

Import the data from an xls file

VERSION = 1
get_data()

Return the object’s matrix

Parameters:

self (ImportMatrixVal) – An ImportMatrixVal object

Returns:

matrix – The object’s matrix

Return type:

ndarray

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 file_path

Path of the file to load

Type:

str

property sheet

Name of the sheet to load

Type:

str

property skiprows

To skip some rows in the file (header)

Type:

int

Min:

0

property usecols

F”)

Type:

str

Type:

list of Excel column letters and column ranges (e.g. “A

Type:

E” or “A,C,E

property axes_colrows

To read axes in first line/column

Type:

dict

property is_allsheets

To read all sheets in a 3D matrix

Type:

bool