create_dataset#

Mechanical.create_dataset(dsname, xlist, ylist, zlist=None, vlist=None, is_project_dataset=True, xunit='', yunit='', zunit='', vunit='')[source]#

Create a dataset.

Parameters:
dsnamestr

Name of the dataset (without a prefix for a project dataset).

xlistlist

List of X-axis values for the dataset.

ylistlist

List of Y-axis values for the dataset.

zlistlist, optional

List of Z-axis values for a 3D dataset only. The default is None.

vlistlist, optional

List of V-axis values for a 3D dataset only. The default is None.

is_project_datasetbool, optional

Whether it is a project data set. The default is True.

xunitstr, optional

Units for the X axis. The default is "".

yunitstr, optional

Units for the Y axis. The default is "".

zunitstr, optional

Units for the Z axis for a 3D dataset only. The default is "".

vunitstr, optional

Units for the V axis for a 3D dataset only. The default is "".

Returns:
pyaedt.application.Variables.DataSet

Dataset object when the dataset is created, False otherwise.

References

>>> oProject.AddDataset
>>> oDesign.AddDataset