data_source.reaction.crd.utility
================================

.. py:module:: data_source.reaction.crd.utility

.. autoapi-nested-parse::

   The ``data_source.reaction.crd.utility`` package initialization module. 



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/data_source/reaction/crd/utility/download/index
   /autoapi/data_source/reaction/crd/utility/extraction/index
   /autoapi/data_source/reaction/crd/utility/formatting/index


Classes
-------

.. autoapisummary::

   data_source.reaction.crd.utility.ChemicalReactionDatabaseDownloadUtility
   data_source.reaction.crd.utility.ChemicalReactionDatabaseExtractionUtility
   data_source.reaction.crd.utility.ChemicalReactionDatabaseFormattingUtility


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

.. py:class:: ChemicalReactionDatabaseDownloadUtility

   The `Chemical Reaction Database (CRD) <https://kmt.vander-lingen.nl>`_ download utility class. 


   .. py:method:: download_v_reaction_smiles(version: str, output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Download the data from a `v_reaction_smiles_*` version of the database.

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



.. py:class:: ChemicalReactionDatabaseExtractionUtility

   The `Chemical Reaction Database (CRD) <https://kmt.vander-lingen.nl>`_ extraction utility class. 


   .. py:method:: extract_v_reaction_smiles(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Extract the data from a `v_reaction_smiles_*` version of the database.

      :parameter version: The version of the database.
      :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:class:: ChemicalReactionDatabaseFormattingUtility

   The `Chemical Reaction Database (CRD) <https://kmt.vander-lingen.nl>`_ formatting utility class. 


   .. py:method:: format_v_reaction_smiles(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from a `v_reaction_smiles_*` version of the database.

      :parameter version: The version of the database.
      :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.