gcubed.data.equation_map

class EquationMap:
EquationMap()

Dependency injection - no argument instantiation.

is_fully_configured: bool

Returns

True if the required properties have been configured and False otherwise.

The required properties are:

sym_data: gcubed.sym_data.SymData

Returns

The SymData object

model_configuration: gcubed.model_configuration.ModelConfiguration

Returns

The model configuration object

data: pandas.core.frame.DataFrame

Returns

The equation map data.

The dataframe has the columns:

  • lhs_name: The name of the LHS variable
  • lhs_prefix: The prefix of the LHS variable name
  • lhs_vector: The vector name of the LHS variable
  • lhs_sequence: The sequence of the LHS variable
  • rhs_name: The name of the RHS variable
  • rhs_prefix: The prefix of the RHS variable name
  • rhs_vector: The vector name of the RHS variable
  • rhs_sequence: The sequence of the RHS variable

There is a row for each RHS variable in each equation.

All rows are unique.

def rhs_variables(self, lhs_variable_name: str) -> pandas.core.frame.DataFrame:

Arguments

  • lhs_variable_name: The LHS variable

Returns

A dataframe containing the details of the RHS variables in the equation for the given LHS variable.

The dataframe has the columns:

  • rhs_name: The name of the RHS variable
  • rhs_prefix: The prefix of the RHS variable name
  • rhs_vector: The vector name of the RHS variable
  • rhs_sequence: The sequence of the RHS variable
def lhs_variables(self, rhs_variable_name: str) -> pandas.core.frame.DataFrame:

Arguments

  • rhs_variable_name: The RHS variable name

Returns

A dataframe containing the details of the RHS variables in the equation for the given LHS variable.

The dataframe has the columns:

  • lhs_name: The name of the LHS variable
  • lhs_prefix: The prefix of the LHS variable name
  • lhs_vector: The vector name of the LHS variable
  • lhs_sequence: The sequence of the LHS variable
def lhs_variable(self, lhs_variable_name: str) -> pandas.core.series.Series:

Overview

Return the full set of details about the LHS variable with the given name.

Arguments

  • lhs_variable_name: The name of the variable

Returns

The details of the LHS variable including:

  • lhs_name: The name of the LHS variable
  • lhs_prefix: The prefix of the LHS variable name
  • lhs_vector: The vector name of the LHS variable
  • lhs_sequence: The sequence of the LHS variable
def is_lhs_variable(self, lhs_variable_name: str) -> bool:

Arguments

  • lhs_variable_name: The variable to check

Returns

True if the variable is a LHS variable and False otherwise.

def is_rhs_variable(self, rhs_variable_name: str) -> bool:

Arguments

  • rhs_variable_name: The variable to check

Returns

True if the variable is a RHS variable and False otherwise.