Source code for sierra.core.graphs.bcbridge

#
# Copyright 2025 John Harwell, All rights reserved.
#
# SPDX-License-Identifier: MIT
#
"""
Bridge/glue interfaces/bindings for :term:`Batch Criteria` which can be graphed.
"""

# Core packages
import pathlib
import typing as tp
import dataclasses

# 3rd party packages

# Project packages
from sierra.core import types




@dataclasses.dataclass
class GraphInfo:
    """
    Container of info for generating graphs from batch criteria.

    Attributes:
        cmdopts: Dictionary of parsed command line options. Most batch
                 criteria will not need this to compute things, BUT it is
                 available.

        batch_output_root: Root directory for all experimental output in the
                           batch. Needed in calculating graphs for batch
                           criteria when ``--exp-range`` is used.

        exp_names: The names of experiment directories to instantiate on the
                   filesystem.

        xticklabels: Labels for the xticks.

        xticks: The x-axis ticks.

        yticklabels: Labels for the yticks.

        yticks: The y-axis ticks.

    """

    cmdopts: types.Cmdopts
    batch_output_root: tp.Optional[pathlib.Path] = None
    exp_names: tp.Optional[list[str]] = None
    xticklabels: list[str] = dataclasses.field(default_factory=list)
    xticks: list[float] = dataclasses.field(default_factory=list)
    xlabel: str = ""
    yticklabels: list[str] = dataclasses.field(default_factory=list)
    yticks: list[float] = dataclasses.field(default_factory=list)
    ylabel: str = ""





class IGraphable:
    """
    Interface for batch criteria for usage with :ref:`plugins/prod/graphs`.
    """



    def graph_info(
        self,
        cmdopts: types.Cmdopts,
        batch_output_root: tp.Optional[pathlib.Path] = None,
        exp_names: tp.Optional[list[str]] = None,
    ) -> GraphInfo:
        """
        Generate graph info for generating graphs from :term:`Batch Criteria`.

        Arguments:

           exp_names: Needed as an optional for bivariate batch
                      criteria.  When calculating say yticks using criteria2, if
                      criteria2 uses ``populations()`` in the process,
                      the criteria's OWN ``gen_exp_names()`` will be used, which
                      will result in bad directory name calculations.  This can
                      be overcome by passing the list of exp names to use at
                      THIS level, which should override the value otherwise
                      present in :class:`GraphInfo`.
        """
        raise NotImplementedError




__all__ = ["GraphInfo", "IGraphable"]