Usage 
=====

Generic import
--------------

To use the package just import:

``import py3dic``

or 

``import py3dic as mlt``

To check if the installation is ok use:

``mlt.__version__`` 



..  MAth support
    | ------------
    | assuming everything is ok, this should present an equation:
    |.. math::
    |
    |    E = mc^2
    |
    |.. math::
    |
    |    \int_{-\infty}^\infty e^{-x^2} dx = \sqrt{\pi}


DIC Analysis
------------

To use the DIC analysis tools, the easiest method is to use the package entry points. Run the following command in a terminal:

``tk_dic_analysis``

This command opens a GUI for batch DIC analysis using camera data, which can calculate:

* Strain maps
* Displacement maps
* Other relevant measurements

To merge and synchronize DIC data from both cameras and tensile testing machines, run:

``tk_dic_merge``

Prerequisites for using ``tk_dic_merge``:

1. First run ``tk_dic_analysis`` to produce results
2. Prepare your tensile machine data by:

   * Converting it to the machine-agnostic format used by the py3dic package (an ASCII file with extension ``.autd``)
   * Using tab (``\t``) as separator and dot (``.``) as decimal
   * Ensuring the first line contains the column names: ``force_N``, ``disp_mm``, ``time_s``
   * Placing the converted file in the "data_tensile" folder within the experiment folder

After launching ``tk_dic_merge``, follow these steps:

1. Select the ``.xlsx`` file produced by ``tk_dic_analysis`` from the results folder
   * The tool will automatically attempt to locate the "data_tensile" folder and corresponding ``.autd`` machine data file (compatible with Imada, Janin, and other machines)
2. Synchronize the camera and tensile data using the offset slider in the GUI's right pane
3. After setting the time offset between camera and tensile data, click "Perform Analysis" to generate final results