orbithunter.EquilibriumOrbitKS.filename

EquilibriumOrbitKS.filename(extension='.h5', decimals=3, cls_name=True)

Method for convenience and consistent/conventional file naming.

Parameters:

extensionstr

The extension to append to the filename

decimals

The number of decimals to include in the str name of the orbit.

cls_name

Whether or not to include str(self) in the filename.

Returns

——-

str

The conventional filename.

Notes

More dimensions means longer filenames.

Examples

For an orbit with t=10, x=5.321 this would yield Orbit_t10p000_x5p321