kaitiaki
========

.. py:module:: kaitiaki


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/kaitiaki/OptionLexer/index
   /autoapi/kaitiaki/STARSController/index
   /autoapi/kaitiaki/_metadata/index
   /autoapi/kaitiaki/augments/index
   /autoapi/kaitiaki/binary/index
   /autoapi/kaitiaki/classifier/index
   /autoapi/kaitiaki/constants/index
   /autoapi/kaitiaki/file/index
   /autoapi/kaitiaki/file_handlers/index
   /autoapi/kaitiaki/helpers/index
   /autoapi/kaitiaki/kicks/index
   /autoapi/kaitiaki/sntools/index
   /autoapi/kaitiaki/terminal/index
   /autoapi/kaitiaki/utils/index


Attributes
----------

.. autoapisummary::

   kaitiaki.__version__
   kaitiaki.stars
   kaitiaki.log


Functions
---------

.. autoapisummary::

   kaitiaki.load_file
   kaitiaki.format_metallicity
   kaitiaki.debug
   kaitiaki.deprecate
   kaitiaki.run


Package Contents
----------------

.. py:data:: __version__
   :value: '1.0.0a'


.. py:data:: stars

.. py:function:: load_file(filename)

.. py:function:: format_metallicity(Z)

.. py:data:: log

.. py:function:: debug(msgtype, message, fatal=False)

   General purpose debug message handler

   Allows us to print to stdout when debugging (developing) and fail
   on production.

   :param msgtype {string} -- The message type to throw. Must be 'info':
   :param 'warning':
   :param or 'error'.:
   :param message {string} -- The message to throw.:


.. py:function:: deprecate(func)

.. py:function:: run(lexer)