:py:mod:`starling_sim.utils.data_tree`
======================================

.. py:module:: starling_sim.utils.data_tree

.. autoapi-nested-parse::

   This module contains functions for the creation of the data folder tree and
   the import of example scenarios from Tellae's Google Drive.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   starling_sim.utils.data_tree.create_data_tree
   starling_sim.utils.data_tree.import_examples
   starling_sim.utils.data_tree.import_examples_from_test_data
   starling_sim.utils.data_tree.sh_copy



.. py:function:: create_data_tree()

   Create the data tree according to the paths stored in paths.py.


.. py:function:: import_examples()

   Import the example scenarios from the test folders.


.. py:function:: import_examples_from_test_data(test_data_folder)

   Copy the example data from the given test folder to the data folder.

   Caution : this will reproduce the folder tree of the test folder. Only the
   custom data folder will be used.

   :param test_data_folder: data folder to copy


.. py:function:: sh_copy(src, dst)

   Copy the source file/folder in the destination folder.

   We use the recursive option of cp, so folders will be copied recursively.

   :param src: path to the source folder
   :param dst: path to the destination folder