readligo.read_hdf5
==================

Back to :doc:`Module page <../modules/readligo>`

Summary
-------

Helper function to read HDF5 files

Signature
---------

.. code-block:: python

   def read_hdf5(filename, readstrain = True)

.. list-table:: Input variables
   :header-rows: 1

   * - Name
     - Type
     - Default
     - Description
   * - ``filename``
     - -
     - -
     - -
   * - ``readstrain``
     - -
     - True
     - -

Output variables
----------------

.. list-table::
   :header-rows: 1

   * - Return annotation
     - Docstring type
     - Description
   * - ``None``
     - -
     - -

Docstring
---------

.. code-block:: text

   Helper function to read HDF5 files