carbatpy.helpers
================

.. py:module:: carbatpy.helpers


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/carbatpy/helpers/create_param_sets_saltelli_multi/index
   /autoapi/carbatpy/helpers/file_copy/index
   /autoapi/carbatpy/helpers/input_dict/index
   /autoapi/carbatpy/helpers/json_yaml_attribute_store_load/index
   /autoapi/carbatpy/helpers/opti_cycle_comp_helpers/index
   /autoapi/carbatpy/helpers/ser_dict/index


Attributes
----------

.. autoapisummary::

   carbatpy.helpers.END_NAME


Functions
---------

.. autoapisummary::

   carbatpy.helpers.copy_script_add_date


Package Contents
----------------

.. py:function:: copy_script_add_date(file_name_end, source_file, directory)

   File handling, copy the actual py-File after
   adding the actual date-time and copy it to a directory which is also named
   date-time - file_name_end
   return the date-time for further usage

   :param file_name_end: the file name to be added to the date, also for the directory name.
   :type file_name_end: string
   :param source_file: The source file to copy (from __file__).
   :type source_file: string
   :param directory: The directory to copy to.
   :type directory: string

   :returns: **directory** -- The new directory name and the file name(s) without extension.
   :rtype: String


.. py:data:: END_NAME
   :value: 'test'