ncsw_data.source.compound
=========================

.. py:module:: ncsw_data.source.compound

.. autoapi-nested-parse::

   The ``ncsw_data.source.compound`` package initialization module. 



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ncsw_data/source/compound/chembl/index
   /autoapi/ncsw_data/source/compound/coconut/index
   /autoapi/ncsw_data/source/compound/compound/index
   /autoapi/ncsw_data/source/compound/miscellaneous/index
   /autoapi/ncsw_data/source/compound/zinc/index


Classes
-------

.. autoapisummary::

   ncsw_data.source.compound.CompoundDataSource


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

.. py:class:: CompoundDataSource(logger: Optional[logging.Logger] = None)

   Bases: :py:obj:`ncsw_data.source.base.base.DataSourceBase`


   The chemical compound data source class. 

   The `__init__` method of the class.

   :parameter logger: The logger. The value `None` indicates that the logger should not be utilized.


   .. py:attribute:: supported_data_sources


   .. py:method:: get_names_of_supported_data_sources() -> List[str]

      Get the names of the supported data sources.

      :returns: The names of the supported data sources.



   .. py:method:: get_supported_versions(name: str) -> Dict[str, str]

      Get the supported versions of a data source.

      :parameter name: The name of the data source.

      :returns: The supported versions of the data source.



   .. py:method:: download(name: str, version: str, output_directory_path: Union[str, os.PathLike[str]], **kwargs) -> None

      Download the data from a data source.

      :parameter name: The name of the data source.
      :parameter version: The version of the data source.
      :parameter output_directory_path: The path to the output directory where the data should be downloaded.



   .. py:method:: extract(name: str, version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]], **kwargs) -> None

      Extract the data from a data source.

      :parameter name: The name of the data source.
      :parameter version: The version of the data source.
      :parameter input_directory_path: The path to the input directory where the data is downloaded.
      :parameter output_directory_path: The path to the output directory where the data should be extracted.



   .. py:method:: format(name: str, version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]], **kwargs) -> None

      Format the data from a data source.

      :parameter name: The name of the data source.
      :parameter version: The version of the data source.
      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.