kaitiaki.file_handlers.outfile
==============================

.. py:module:: kaitiaki.file_handlers.outfile


Exceptions
----------

.. autoapisummary::

   kaitiaki.file_handlers.outfile.DeprecationWarning


Classes
-------

.. autoapisummary::

   kaitiaki.file_handlers.outfile.ModelSummary
   kaitiaki.file_handlers.outfile.ModelProfile
   kaitiaki.file_handlers.outfile.outfile
   kaitiaki.file_handlers.outfile.outfile2


Functions
---------

.. autoapisummary::

   kaitiaki.file_handlers.outfile.get_last_converged_model


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

.. py:exception:: DeprecationWarning

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


.. py:function:: get_last_converged_model(file)

.. py:class:: ModelSummary(model)

   .. py:method:: _parse_block(model)


   .. py:attribute:: _modelnum


   .. py:attribute:: _mass


   .. py:method:: nan_num()


   .. py:method:: original_format()


   .. py:method:: get(param, at=None)


   .. py:method:: all_attributes()


   .. py:method:: __str__()


.. py:class:: ModelProfile(array)

   .. py:attribute:: _array


.. py:class:: outfile(file='out', reindex_modelnums=False)

   Represents an *out* file object.


   .. py:method:: _get_models_from_contents(contents, reindex_modelnums)


   .. py:method:: _get_profiles_from_contents(contents, K=199)


   .. py:method:: _tomso(filename)

      Reads a STARS `out` file and returns (part of) the summaries and
      profiles in two structured arrays.

      :param filename: Filename of the STARS output file to load.
      :type filename: str

      :returns: * **summaries** (*2-d structured array*) -- Summaries of each model in the run, similar to MESA's
                  `history` files.
                * **profiles** (*3-d structured array*) -- Model profiles produced at regular intervals during the run.
                  The first index of the array is the profile number.



   .. py:attribute:: _models


   .. py:attribute:: _profiles


   .. py:attribute:: __size
      :value: 0



   .. py:attribute:: __detailed_idx
      :value: 0



   .. py:method:: __del__()


   .. py:method:: get_by_modelnum(modelnum)


   .. py:method:: get(param, at=None)


   .. py:method:: detailed_profile(idx)


   .. py:method:: detailed_profile_history()


   .. py:method:: __iter__()


   .. py:method:: __next__()


   .. py:method:: __len__()


   .. py:method:: last()


   .. py:method:: find_column(param: str)


   .. py:method:: build_network(param: str)


   .. py:method:: visualise_parameter_network(param: str, mode: str = '2d', nrows: int = 1, ncols: int = 1, fidelity: int = 100, span: tuple = (None, None), make_cbar: bool = True, figsize=None, transform=lambda x: x, ax=None)


.. py:class:: outfile2(file_location='out2', reindex_modelnums=False)

   Bases: :py:obj:`outfile`


   Represents an *out* file object.