kaitiaki.file
=============

.. py:module:: kaitiaki.file


Attributes
----------

.. autoapisummary::

   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


Functions
---------

.. autoapisummary::

   kaitiaki.file.load


Module Contents
---------------

.. py:data:: plot

.. py:data:: plot2

.. py:data:: sneplot

.. py:data:: sneplot2

.. py:data:: out

.. py:data:: out2

.. py:data:: outfile

.. py:data:: data

.. py:data:: modin

.. py:data:: modout

.. py:data:: modin2

.. py:data:: modout2

.. py:function:: load(path_to_file: str)

   Loads a STARS file.

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

   :param path_to_file: The path to the file to load
   :type path_to_file: str

   :returns: An instance of the file
   :rtype: (mixed)

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