:orphan:

Examples
========

This directory contains examples of how to use the SDA library.

Data Loading
-----------

- **``load_2021_2022_test_data.py``** - Load test data from 2021-2022 period
- **``load_all_test_data.py``** - Load all available test data
- **``load_tests.py``** - Simple example of loading specific tests

Utilities
---------

- **``print_all_datafiles.py``** - Discover and print information about all available data files
  on this machine

Performance Analysis
-------------------

- **``database_report_analysis.py``** - Comprehensive test data analysis script:
  - Analyzes ALL available test data on the machine
  - STT template tracking and compliance metrics
  - Visual quality thermometer with progress bars
  - Performance metrics (parsing speed, file sizes)
  - Enhanced Excel reports with native tables

.. code-block:: bash

   python examples/database_report_analysis.py



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This script analyzes all available test data on the machine and provides comprehensive database metrics about tests, files, table detection, worksheet structure, and processing success rates.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_database_report_analysis.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SDA Database Report Analysis Script.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="List all data files in a specific test folder.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_list_all_files_in_test.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">List all data files in a specific test folder.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to load the test data for the years 2021 and 2022 using the high-level :pysda.api.load.load_test function.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_load_2021_2022_test_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load 2021-2022 test data.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to load multiple test data files using the library&#x27;s centralized functions for batch operations : :py~sda.api.load.list_all_files and :py~sda.api.load.parse_files.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_load_all_test_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load all test data.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to load multiple test data files using the unified load_tests() function from the library that handles both file discovery and parsing.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_load_tests.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load tests with unified function.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This script prints all data files synchronized on this local machines. Files are not necessarily downloaded.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_print_all_datafiles.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Print all local data files.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to run the SDA Dashboard for interactive data visualization. The dashboard provides scatter plots and line plots with filtering capabilities for experimental data analysis.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_run_dashboard.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SDA Dashboard Example.</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/database_report_analysis
   /auto_examples/list_all_files_in_test
   /auto_examples/load_2021_2022_test_data
   /auto_examples/load_all_test_data
   /auto_examples/load_tests
   /auto_examples/print_all_datafiles
   /auto_examples/run_dashboard


.. 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>`