netechos.plot

Methods for plotting network model information.

NetworkPlot(model, theme='ticks')

Object with basic plotting methods for model properties.

PARAMETER	DESCRIPTION
model	An instance of a nim.core.NetworkModel object. TYPE: NetworkModel
theme	Name of a Seaborn theme style. Used to set plot styling. TYPE: str {'ticks', 'whitegrid'} DEFAULT: 'ticks'

RETURNS	DESCRIPTION
Self	An instance of the NetworkPlot object. TYPE: Self @ NetworkPlot

Source code in src/netechos/plot.py

def __init__(
    self: Self,
    model: NetworkModel,
    theme: Literal["ticks", "whitegrid", "darkgrid"] = "ticks",
) -> Self:
    """Object to hold plots and plotting methods.

    Parameters
    ----------
    model : NetworkModel
        An instance of a nim.core.NetworkModel object.
    theme : str {'ticks', 'whitegrid'}, optional, default: 'ticks'
        Name of a Seaborn theme style. Used to set plot styling.

    Returns
    -------
    Self : Self@NetworkPlot
        An instance of the NetworkPlot object.

    """
    self.summary_table = model.summary_table
    self.attitude_tracker = model.attitude_tracker
    sns.set_theme(context="notebook", style=theme)

attitude_and_connection_means(fig_width=7, fig_height=3)

Plot mean attitude over time.

PARAMETER	DESCRIPTION
fig_width	Figure width, in inches. TYPE: float DEFAULT: 7
fig_height	Figure height, in inches. TYPE: float DEFAULT: 3

RETURNS	DESCRIPTION
Self	An instance of the NetworkPlot object. TYPE: Self @ NetworkPlot

Source code in src/netechos/plot.py

def attitude_and_connection_means(
    self: Self,
    fig_width: float = 7,
    fig_height: float = 3,
) -> Self:
    """Plot mean attitude over time.

    Parameters
    ----------
    fig_width : float, optional, default: 7
        Figure width, in inches.
    fig_height : float, optional, default: 3
        Figure height, in inches.

    Returns
    -------
    Self : Self@NetworkPlot
        An instance of the NetworkPlot object.

    """
    tmax = self.summary_table["time"].max()
    fig, (ax0, ax1) = plt.subplots(1, 2, figsize=(fig_width, fig_height))
    ax0.hlines(y=0, xmin=0, xmax=tmax, color="#444444")
    sns.lineplot(
        data=self.summary_table,
        x="time",
        y="attitude_mean",
        ax=ax0,
    )
    sns.lineplot(
        data=self.summary_table,
        x="time",
        y="connection_mean",
        ax=ax1,
    )
    ax0.set_xscale("log")
    ax1.set_xscale("log")
    sns.despine(ax=ax0)
    sns.despine(ax=ax1)
    fig.tight_layout()
    self.means_over_time = fig
    return self

node_attitudes_over_time(fig_width=5, fig_height=3)

Plot individual node attitudes over time.

PARAMETER	DESCRIPTION
fig_width	Figure width, in inches. TYPE: float DEFAULT: 7
fig_height	Figure height, in inches. TYPE: float DEFAULT: 3

RETURNS	DESCRIPTION
Self	An instance of the NetworkPlot object. TYPE: Self @ NetworkPlot

Source code in src/netechos/plot.py

def node_attitudes_over_time(
    self: Self,
    fig_width: float = 5,
    fig_height: float = 3,
) -> Self:
    """Plot individual node attitudes over time.

    Parameters
    ----------
    fig_width : float, optional, default: 7
        Figure width, in inches.
    fig_height : float, optional, default: 3
        Figure height, in inches.

    Returns
    -------
    Self : Self@NetworkPlot
        An instance of the NetworkPlot object.

    """
    tmax = self.attitude_tracker["time"].max()
    self.attitude_tracker = self.attitude_tracker.with_columns(
        attitude_sin=pl.col("attitude").sin(),
    )
    fig, ax = plt.subplots(figsize=(fig_width, fig_height))
    ax.hlines(y=0, xmin=0, xmax=tmax, color="#444444")
    sns.lineplot(
        data=self.attitude_tracker,
        x="time",
        y="attitude_sin",
        hue="node",
        ax=ax,
    )
    sns.despine(ax=ax)
    sns.move_legend(ax, loc="upper left", bbox_to_anchor=(1, 1))
    fig.tight_layout()
    self.means_over_time = fig
    return self