kaitiaki.file_handlers.modelfile
================================

.. py:module:: kaitiaki.file_handlers.modelfile


Classes
-------

.. autoapisummary::

   kaitiaki.file_handlers.modelfile.Model
   kaitiaki.file_handlers.modelfile.ModelFile
   kaitiaki.file_handlers.modelfile.modin
   kaitiaki.file_handlers.modelfile.modout
   kaitiaki.file_handlers.modelfile.modin2
   kaitiaki.file_handlers.modelfile.modout2


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

.. py:class:: Model(model_df, delta_df, metadata, raw)

   .. py:attribute:: __data


   .. py:method:: __getitem__(item)


   .. py:method:: text()


.. py:class:: ModelFile(file_location)

   .. py:attribute:: __models
      :value: []



   .. py:attribute:: __NM2


   .. py:attribute:: __length
      :value: 0



   .. py:method:: __len__()


   .. py:method:: request_indexes()


   .. py:method:: get(index)


   .. py:method:: get_by_plotfile_timestep(timestep)


   .. py:method:: get_by_modelnum(modelnum)


   .. py:method:: plot(parameter, timestep_index=0, transformation=None, labelname='')


.. py:class:: modin(file_location='modin')

   Bases: :py:obj:`ModelFile`


.. py:class:: modout(file_location='modout')

   Bases: :py:obj:`ModelFile`


.. py:class:: modin2(file_location='modin2')

   Bases: :py:obj:`ModelFile`


.. py:class:: modout2(file_location='modout2')

   Bases: :py:obj:`ModelFile`