.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/list_all_experiment_files.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        You can download :ref:`below <sphx_glr_download_auto_examples_list_all_experiment_files.py>`
        the full example code. and run it online in `Codespaces <https://codespaces.new/spark-cleantech-l3/sda-copy?quickstart=1>`__

        .. image:: https://github.com/codespaces/badge.svg
            :target: https://codespaces.new/spark-cleantech-l3/sda-copy?quickstart=1

---

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_list_all_experiment_files.py:


Show all local data files.
===========================

This script lists all data files synchronized on this local machines. Files
are not necessarily downloaded. They will be automatically downloaded
if you need to open them.

Run from command line:

```bash
sda list
```

Typically returns something like :

```
  117. T327
  118. T330
  119. T333
  120. T334
  121. T336
  122. T339
  123. T341
  124. T343
  125. T344
  126. T345
  127. T346
  128. T348
  129. T358
  130. T359
  131. T360
  132. T362
  133. T363
  134. T364
  135. T365

✅ Found 135 tests in total
```

The script uses :py:func:`sda.api.load.list_all_files` which
looks into all the Data Sharepoints synchronized on this machine either
by having clicked the "Sync" (recommended) or "Add a Shortcut to my Drive"
(not recommended, but works) buttons from the online Sharepoint / Documents page.

Data Sharepoints local links must be defined in the local "~/sda.json" configuration
file.

Then, files shall be loaded using :py:func:`sda.api.load.load_test` or
:py:func:`sda.api.load.load_tests` e.g. with:

```python
from sda.api.load import load_test
df = load_test("T327")
```

OR

```python
from sda.api.load import load_tests
df = load_tests(["T327", "T330"])
```

.. GENERATED FROM PYTHON SOURCE LINES 65-72

.. code-block:: Python


    from sda.api import list_all_tests

    if __name__ == "__main__":
        # See documentation above for the CLI version of this
        files = list_all_tests()
        print(f"✅ Found {len(files)} files in total")


.. _sphx_glr_download_auto_examples_list_all_experiment_files.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

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

      :download:`Download Jupyter notebook: list_all_experiment_files.ipynb <list_all_experiment_files.ipynb>`

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

      :download:`Download Python source code: list_all_experiment_files.py <list_all_experiment_files.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: list_all_experiment_files.zip <list_all_experiment_files.zip>`