ncsw_data.source.reaction_pattern.retro_rules.utility
=====================================================

.. py:module:: ncsw_data.source.reaction_pattern.retro_rules.utility

.. autoapi-nested-parse::

   The ``ncsw_data.source.reaction_pattern.retro_rules.utility`` package initialization module. 



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ncsw_data/source/reaction_pattern/retro_rules/utility/download/index
   /autoapi/ncsw_data/source/reaction_pattern/retro_rules/utility/extraction/index
   /autoapi/ncsw_data/source/reaction_pattern/retro_rules/utility/formatting/index


Classes
-------

.. autoapisummary::

   ncsw_data.source.reaction_pattern.retro_rules.utility.RetroRulesReactionPatternDatabaseDownloadUtility
   ncsw_data.source.reaction_pattern.retro_rules.utility.RetroRulesReactionPatternDatabaseExtractionUtility
   ncsw_data.source.reaction_pattern.retro_rules.utility.RetroRulesReactionPatternDatabaseFormattingUtility


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

.. py:class:: RetroRulesReactionPatternDatabaseDownloadUtility

   The `RetroRules <https://retrorules.org>`_ chemical reaction pattern database download utility class. 


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


      Download the data from a `v_release_*` 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:: RetroRulesReactionPatternDatabaseExtractionUtility

   The `RetroRules <https://retrorules.org>`_ chemical reaction pattern database extraction utility class. 


   .. py:method:: extract_v_release(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_release_*` 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:: RetroRulesReactionPatternDatabaseFormattingUtility

   The `RetroRules <https://retrorules.org>`_ chemical reaction pattern database formatting utility class. 


   .. py:method:: format_v_release(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_release_*` 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.