:orphan:

============================
Examples of using tidynamics
============================

The examples below show how one can use tidynamics to compute correlations and
mean-squared displacements (MSD).

The example "Command-line interface to tidynamics" runs in the command-line. It performs the
two basic operations of tidynamics (autocorrelation function and MSD) using files as input
data. The file ``random_steps_sample_0.txt.gz`` contains example data for computing the
autocorrelation function and the file ``random_walk_sample_0.txt.gz`` contains example data
for computing the MSD.

The following commands run the command-line tool::

    python tidynamics_tool.py msd random_walk_sample_0.txt.gz random_walk_msd_0.txt
    python tidynamics_tool.py acf random_steps_sample_0.txt.gz random_steps_acf_0.txt

The output is stored in the files ``random_walk_msd_0.txt`` and ``random_steps_acf_0.txt``.

The other examples require `matplotlib <https://matplotlib.org/>`_.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The program reads in data from the file input_file (using np.loadtxt from NumPy) and performs t...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_tidynamics_tool_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_tidynamics_tool.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Command-line interface to tidynamics</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Compute the autocorrelation for varying time series lengths.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_nlogn_scaling_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_nlogn_scaling.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Scaling behaviour</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Generate the velocity for a Ornstein-Uhlenbeck process and compute its autocorrelation function...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_acf_1_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_acf_1.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Correlation functions</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Generate a number of random walks and compute their MSD.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_msd_1_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_msd_1.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mean-square displacements (MSD)</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/tidynamics_tool
   /auto_examples/plot_nlogn_scaling
   /auto_examples/plot_acf_1
   /auto_examples/plot_msd_1


.. only:: html

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

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

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

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

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