:py:mod:`pytmosph3r.interface.hdf5`
===================================

.. py:module:: pytmosph3r.interface.hdf5


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

.. py:class:: HDF5Input(filename)


   Bases: :py:obj:`pytmosph3r.interface.io.Input`

   Base class to read input data.
   :class:`~pytmosph3r.interface.HDF5Input` and
   :class:`~pytmosph3r.interface.ncInput` inherit from it.

   .. py:property:: attrs


   .. py:method:: getclass(path)


   .. py:method:: get(path)



.. py:class:: HDF5Output(filename, append=False)


   Bases: :py:obj:`pytmosph3r.interface.io.Output`, :py:obj:`HDF5Input`

   Base class to write outputs.
   :class:`~pytmosph3r.interface.HDF5Output` and
   :class:`~pytmosph3r.interface.ncOutput` inherit from it.

   .. py:method:: get(path)
      :abstractmethod:


   .. py:method:: getclass(path)
      :abstractmethod:


   .. py:method:: write_string_array(string_array, string_name=None, metadata=None)



.. py:class:: HDF5Group(f)


   Bases: :py:obj:`HDF5Output`, :py:obj:`abc.ABC`

   Base class to write outputs.
   :class:`~pytmosph3r.interface.HDF5Output` and
   :class:`~pytmosph3r.interface.ncOutput` inherit from it.


.. py:function:: write_hdf5(h5_output, model, group_name='Model', items=None)

   Write :attr:`model` into group `group_name` in HDF5 `h5_output`. The output file is separated into a group "Model" with the inputs, and a group "Output" with the outputs.

   :param h5_output: Name of HDF5 output file.
   :type h5_output: string
   :param model: Model to write.
   :type model: :class:`~pytmosph3r.model.model.Model`
   :param group_name: Either "Model", "Output", or "All". Decides which data to write to :attr:`group_name`: "Model" writes the input model only, "Output" writes the output data, and "All" writes everything. Defaults to "Model".
   :type group_name: str, optional
   :param items: items to write into group.
   :type items: list