API documentation#

Model parsing – dsafeatures.parsing#

Parse a model from a CSV file.

dsafeatures.parsing.parse_symbols(data: ~pandas.core.frame.DataFrame, *, inplace: bool = False, cls=<class 'sympy.core.symbol.Symbol'>, assumptions: dict = None) → Series[source]#

Parse variables table.

Parameters:

data – Table with variable information.

Returns:

vars – parsed variables

Examples

>>> data = pd.DataFrame(data={'latex': [r'\dot{x}', r'\frac{a}{2}']})
>>> parse_symbols(data)
0        \dot{x}
1    \frac{a}{2}
Name: sympy, dtype: object

>>> parse_symbols(data,inplace=True)
>>> data
         latex        sympy
0      \dot{x}      \dot{x}
1  \frac{a}{2}  \frac{a}{2}
dsafeatures.parsing.parse_equation(data: DataFrame, *, context: dict = None, inplace: bool = False) → Series | None[source]#

Parse equations from data.

dsafeatures.parsing.parse_matrix(data: DataFrame, *, context: dict = None, on_rows: str = None)[source]#

Parse matrix from DataFrame.

dsafeatures.parsing.read_model_file(fname: Path | str, *, is_matrix: bool = False) → DataFrame[source]#

Read a CSV with model components defined on it.

dsafeatures.parsing.parse_model(model: str, *, path: Path) → tuple[dict[str, Any], dict[str, dict]][source]#

Parse all files from model.

Parameters:

  • model – Model prefix.

  • path – Path to model folders.

Returns:

  • components – dictionary of model components like states, matrix, etc.

  • contexts – dictionary of context used for substitutions and other sympy operations.

Model files – dsafeatures.models#