kaitiaki.file

Attributes

`plot`
`plot2`
`sneplot`
`sneplot2`
`out`
`out2`
`outfile`
`data`
`modin`
`modout`
`modin2`
`modout2`

Functions

load(path_to_file)

Loads a STARS file.

Module Contents

kaitiaki.file.plot

kaitiaki.file.plot2

kaitiaki.file.sneplot

kaitiaki.file.sneplot2

kaitiaki.file.out

kaitiaki.file.out2

kaitiaki.file.outfile

kaitiaki.file.data

kaitiaki.file.modin

kaitiaki.file.modout

kaitiaki.file.modin2

kaitiaki.file.modout2

kaitiaki.file.load(path_to_file: str)

Loads a STARS file.

Loads a STARS file (that has not been renamed).

Parameters:

path_to_file (str) – The path to the file to load

Returns:

An instance of the file

Return type:

(mixed)

Raises:

FileNotFoundError – If the file you are attempting to load doesn’t exist
ValueError – If the file type cannot be inferred from the filename.