:orphan:



.. _sphx_glr_tutorial-read:

Reading data
------------

The main resistics package supports two time data formats and two calibration
data formats.

For time data:

- ASCII (including compressed ASCII, e.g. bz2)
- numpy .npy

Where possible, it is recommended to use the numpy data format for time data
as this is quicker to read from. Whilst it is a binary format, it is portable
and well supported by the numpy package.

For calibration data, resistics supports:

- Text file calibration data
- JSON calibration data

The structure of these two calibration data formats can be seen in the relevant
examples.


.. note::

    Support for other data formats is provided by the resistics-readers package.
    This includes support for Metronix ATS data, SPAM RAW data, Phoenix TS data,
    Lemi data and potentially more in the future.



.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example will show how to read time data from an ASCII file using the default ASCII data re...">

.. only:: html

 .. figure:: /tutorial-read/images/thumb/sphx_glr_eg_01_read_time_ascii_thumb.png
     :alt: Time data ASCII

     :ref:`sphx_glr_tutorial-read_eg_01_read_time_ascii.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorial-read/eg_01_read_time_ascii

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example will show how to read time data from a compressed ASCII file using the default ASC...">

.. only:: html

 .. figure:: /tutorial-read/images/thumb/sphx_glr_eg_02_read_time_bz2_thumb.png
     :alt: Time data bz2

     :ref:`sphx_glr_tutorial-read_eg_02_read_time_bz2.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorial-read/eg_02_read_time_bz2

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="If a data file is available in npy binary format, this can be read in using the TimeReaderNumpy...">

.. only:: html

 .. figure:: /tutorial-read/images/thumb/sphx_glr_eg_03_read_time_binary_thumb.png
     :alt: Time data binary

     :ref:`sphx_glr_tutorial-read_eg_03_read_time_binary.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorial-read/eg_03_read_time_binary

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The preferred format for calibration data is JSON file. Howeer, they are not always as easy to ...">

.. only:: html

 .. figure:: /tutorial-read/images/thumb/sphx_glr_eg_04_read_calibration_json_thumb.png
     :alt: Calibration data JSON

     :ref:`sphx_glr_tutorial-read_eg_04_read_calibration_json.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorial-read/eg_04_read_calibration_json

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An alternative to JSON calibration files is to use text/ASCII calibration files.">

.. only:: html

 .. figure:: /tutorial-read/images/thumb/sphx_glr_eg_05_read_calibration_txt_thumb.png
     :alt: Calibration data TXT

     :ref:`sphx_glr_tutorial-read_eg_05_read_calibration_txt.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorial-read/eg_05_read_calibration_txt
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-gallery


  .. container:: sphx-glr-download sphx-glr-download-python

    :download:`Download all examples in Python source code: tutorial-read_python.zip </tutorial-read/tutorial-read_python.zip>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

    :download:`Download all examples in Jupyter notebooks: tutorial-read_jupyter.zip </tutorial-read/tutorial-read_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_