ncsw_data.source.reaction.ord.utility
=====================================

.. py:module:: ncsw_data.source.reaction.ord.utility

.. autoapi-nested-parse::

   The ``ncsw_data.source.reaction.ord.utility`` package initialization module. 



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ncsw_data/source/reaction/ord/utility/download/index
   /autoapi/ncsw_data/source/reaction/ord/utility/extraction/index
   /autoapi/ncsw_data/source/reaction/ord/utility/formatting/index


Classes
-------

.. autoapisummary::

   ncsw_data.source.reaction.ord.utility.OpenReactionDatabaseDownloadUtility
   ncsw_data.source.reaction.ord.utility.OpenReactionDatabaseExtractionUtility
   ncsw_data.source.reaction.ord.utility.OpenReactionDatabaseFormattingUtility


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

.. py:class:: OpenReactionDatabaseDownloadUtility

   The `Open Reaction Database (ORD) <https://open-reaction-database.org>`_ 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:: OpenReactionDatabaseExtractionUtility

   The `Open Reaction Database (ORD) <https://open-reaction-database.org>`_ 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:: OpenReactionDatabaseFormattingUtility

   The `Open Reaction Database (ORD) <https://open-reaction-database.org>`_ formatting utility class. 


   .. py:method:: _parse_v_release_file(input_file_path: Union[str, os.PathLike[str]]) -> List[Tuple[Optional[str], Ellipsis]]
      :staticmethod:


      Parse a file from a `v_release_*` version of the database.

      :parameter input_file_path: The path to the input file.

      :returns: The parsed input file.



   .. py:method:: format_v_release(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]], number_of_processes: int = 1) -> 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.
      :parameter number_of_processes: The number of processes.