opengate_core
=============

.. py:module:: opengate_core


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/opengate_core/g4DataSetup/index
   /autoapi/opengate_core/g4_bindings/index
   /autoapi/opengate_core/opengate_lib/index
   /autoapi/opengate_core/qt5Setup/index
   /autoapi/opengate_core/testsDataSetup/index


Attributes
----------

.. autoapisummary::

   opengate_core.pathCurrentFile
   opengate_core.reloadPython
   opengate_core.data_packages
   opengate_core.data_packages


Functions
---------

.. autoapisummary::

   opengate_core.get_site_packages_dir
   opengate_core.get_libG4_path
   opengate_core.check_g4_data
   opengate_core.download_with_resume
   opengate_core.download_g4_data
   opengate_core.check_for_non_required_files_folders
   opengate_core.get_missing_g4_data
   opengate_core.get_g4_data_folder
   opengate_core.get_g4_data_paths
   opengate_core.set_g4_data_path
   opengate_core.set_qt5_path
   opengate_core.check_g4_data
   opengate_core.download_with_resume
   opengate_core.download_g4_data
   opengate_core.check_for_non_required_files_folders
   opengate_core.get_missing_g4_data
   opengate_core.get_g4_data_folder
   opengate_core.get_g4_data_paths
   opengate_core.set_g4_data_path


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

.. py:function:: get_site_packages_dir()

.. py:function:: get_libG4_path(lib)

.. py:data:: pathCurrentFile

.. py:data:: reloadPython
   :value: False


.. py:data:: data_packages

.. py:function:: check_g4_data()

.. py:function:: download_with_resume(url, out, retries=5, delay=10)

.. py:function:: download_g4_data(missing_g4_Data=None)

.. py:function:: check_for_non_required_files_folders()

   Check if there are old data folders and inform the user.


.. py:function:: get_missing_g4_data() -> list

.. py:function:: get_g4_data_folder() -> pathlib.Path

.. py:function:: get_g4_data_paths() -> dict

.. py:function:: set_g4_data_path()

.. py:function:: set_qt5_path()

.. py:data:: data_packages

.. py:function:: check_g4_data()

.. py:function:: download_with_resume(url, out, retries=5, delay=10)

.. py:function:: download_g4_data(missing_g4_Data=None)

.. py:function:: check_for_non_required_files_folders()

   Check if there are old data folders and inform the user.


.. py:function:: get_missing_g4_data() -> list

.. py:function:: get_g4_data_folder() -> pathlib.Path

.. py:function:: get_g4_data_paths() -> dict

.. py:function:: set_g4_data_path()