ncsw_data.source.reaction.ord

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

Submodules

Classes

OpenReactionDatabase

The Open Reaction Database (ORD) class.

Package Contents

class ncsw_data.source.reaction.ord.OpenReactionDatabase(logger: logging.Logger | None = None)

Bases: ncsw_data.source.base.base.DataSourceBase

The Open Reaction Database (ORD) class.

The __init__ method of the class.

Parameters:

logger – The logger. The value None indicates that the logger should not be utilized.

static get_supported_versions() → Dict[str, str]

Get the supported versions of the database.

Returns:

The supported versions of the database.

download(version: str, output_directory_path: str | os.PathLike[str], **kwargs) → None

Download the data from the database.

Parameters:

  • version – The version of the database.

  • output_directory_path – The path to the output directory where the data should be downloaded.

extract(version: str, input_directory_path: str | os.PathLike[str], output_directory_path: str | os.PathLike[str], **kwargs) → None

Extract the data from the database.

Parameters:

  • version – The version of the database.

  • input_directory_path – The path to the input directory where the data is downloaded.

  • output_directory_path – The path to the output directory where the data should be extracted.

  • kwargs – The keyword arguments.

format(version: str, input_directory_path: str | os.PathLike[str], output_directory_path: str | os.PathLike[str], **kwargs) → None

Format the data from the database.

Parameters:

  • version – The version of the database.

  • input_directory_path – The path to the input directory where the data is extracted.

  • output_directory_path – The path to the output directory where the data should be formatted.

  • kwargs – The keyword arguments.