API Reference

Display Module

LaTeX equation rendering and formatting

display Display functions for LaTeX rendering
show_eqn Display mathematical equations as formatted LaTeX amsmath block.
check Engineering verification function with localized pass/fail indicators.
latex_inline_dict Generate inline LaTeX equation from a variable and its value in a mapping.
display.format_decimal_numbers Format all decimal numbers in a LaTeX string with specified precision.

Formatters Module

Cell and row formatters for LaTeX equation rendering

formatters Cell and row formatters for LaTeX equation rendering.
format_value Format a value to LaTeX string using type-based dispatch.
formatters.format_str Format Python strings to LaTeX text.
formatters.format_int Format Python integers to LaTeX.
formatters.format_float Format Python floats to LaTeX.
formatters.format_markdown Format IPython Markdown objects to LaTeX text.
formatters.format_latex Format IPython Latex objects to LaTeX text.
formatters.format_pint Format Pint quantities by converting to SymPy first.
formatters.format_sympy Format SymPy expressions to LaTeX.
formatters.format_mul Format Mul expressions with numeric/unit separation.
formatters.validate_latex_kwargs Validate and filter kwargs for sympy.latex() function.

Columns Wrapper Module

Column wrappers for LaTeX equation rendering

col_wrappers Column wrapper for LaTeX equation formatting.
wrap_column Return (prefix, suffix) for column wrapping based on value type.
col_wrappers.wrap_numeric Wrap numeric types with equals prefix in RHS columns.
col_wrappers.wrap_str Wrap strings with quad spacing in RHS columns.
col_wrappers.wrap_sympy Wrap SymPy expressions with equals prefix in RHS columns.
col_wrappers.wrap_pint Wrap Pint quantities with equals prefix in RHS columns.
col_wrappers.wrap_markdown Wrap IPython Markdown/Latex objects with quad spacing in RHS columns.

Label Module

Label generation

label Stable, repeatable unique ID generator for Python objects.
generate_label Generate formatted label text for use with show_eqn.
generate_unique_label Generate unique hash-based labels.

Dataframe Module

Custom dictionary-like container for tabular equation data

dataframe Custom dictionary-like Dataframe class for tabular mathematical data.
Dataframe Custom dictionary-like container for tabular equation data.
dataframe.create_dataframe Create a pre-sized Dataframe with specified shape and initial values.

Pipe Commands Module

Wraps common SymPy functions as decorators for functional composition

pipe_command Pipe commands for functional composition of mathematical operations.

Pint-SymPy Bridge

Integrates Pint unit registry with SymPy symbolic expressions by adding method _sympy_ to pint.Quantity and pint.Unit

pint_sympy Pint-SymPy integration for unit-aware symbolic calculations.

Config Module

Configuration management

config Configuration management for keecas.
config.manager Unified Configuration Management for Keecas.
config.migration Configuration migration engine for keecas.
config.schema Configuration schema definitions and version registry for keecas.

Localization Module

Localization settings

localization Simplified localization module for keecas.
localization.pint_locale Pint locale management and synchronization with keecas language settings.

CLI Module

function of the cli interface

cli Command-line interface for Keecas configuration management.

Utils Module

Utility functions for equation conversion and symbol name escaping

utils Utility functions for YAML processing, symbol handling, and image insertion.
dict_to_eq Convert a dictionary to SymPy Eq object(s).
eq_to_dict Convert SymPy Eq object(s) to dictionary.