larray.Session.to_excel

Session.to_excel(fname, names=None, overwrite=True, display=False, **kwargs)

Dumps Array objects from the current session to an Excel file.

Parameters:

fname : str

Path of the file for the dump.

names : list of str or None, optional

Names of Array objects to dump. Defaults to all Array objects present in the Session.

overwrite: bool, optional

Whether or not to overwrite an existing file, if any. If False, file is updated. Defaults to True.

display : bool, optional

Whether or not to display which file is being worked on. Defaults to False.

Notes

• each array is saved in a separate sheet
• all session metadata is saved in the same sheet named __metadata__

Examples

>>> # scalars
>>> i, s = 5, 'string'                                                      # doctest: +SKIP
>>> # axes
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")                               # doctest: +SKIP
>>> # groups
>>> a01 = a['a0,a1'] >> 'a01'                                               # doctest: +SKIP
>>> # arrays
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)                                  # doctest: +SKIP
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
...                ('arr1', arr1), ('arr2', arr2)])                         # doctest: +SKIP
>>> # metadata
>>> ses.meta.title = 'my title'                                             # doctest: +SKIP
>>> ses.meta.author = 'John Smith'                                          # doctest: +SKIP

Save all arrays (and arrays only)

>>> ses.to_excel('output.xlsx', display=True)                               # doctest: +SKIP
dumping i ... Cannot dump i. int is not a supported type
dumping s ... Cannot dump s. str is not a supported type
dumping a ... Cannot dump a. Axis is not a supported type
dumping b ... Cannot dump b. Axis is not a supported type
dumping a01 ... Cannot dump a01. LGroup is not a supported type
dumping arr1 ... done
dumping arr2 ... done

Save only some arrays

>>> ses.to_excel('output.xlsx', names=['arr1'], display=True)               # doctest: +SKIP
dumping arr1 ... done