connorferster/handcalcs
Handcalcs
handcalcs 是一个数学文档生成器和 Python LaTeX 计算渲染器。它作为一个自动化计算表工具，将 Python 代码和数值计算转换为格式化的 LaTeX 数学文档，既作为符号数学格式化程序，也作为 Jupyter Notebook 数学扩展。
该项目将 Python 变量名转换为希腊符号、下标和标准数学符号。它将代码转换为格式化的数学表达式，显示原始公式、数值代入和最终结果，从而允许创建参数化计算表和人类可读的报告。
该工具涵盖了广泛的渲染功能，包括自动变量下标、内联注释集成和多列参数布局。它支持生成原始 LaTeX 代码、PDF 文档渲染，并与符号数学库集成以处理代数表达式。
该系统使用单元格魔法（Cell Magics）直接集成到 Jupyter Notebook 环境中，以实时显示格式化的方程。
Features
- Automated Engineering Reports - Converts Python calculations into rendered LaTeX equations to create human-readable engineering reports.
- Mathematical Expression Generators - Generates human-readable mathematical reports and LaTeX expressions from Python source code and numeric substitutions.
- Code-to-LaTeX Converters - Transforms Python source code and calculations into formatted LaTeX mathematical expressions for documentation.
- Jupyter Notebook Integrations - Displays formatted mathematical expressions directly within Jupyter Notebooks using cell magics.
- Cell Magic Integrations - Integrates with Jupyter via cell magics to display formatted LaTeX outputs in real-time.
- Mathematical Rendering - Provides a specialized integration for rendering mathematical expressions directly within Jupyter Notebook environments.
- Notebook Math Rendering - Renders Python code as professional LaTeX equations directly within Jupyter notebook environments.
- Python AST Parsing - Analyzes Python source code using abstract syntax trees to convert logic into mathematical notation.
- Automated Calculation Sheets - Provides a framework for generating parameterized mathematical documents and PDFs from dynamic Python calculations.
- Greek Symbol Translation - Translates variable names containing Greek letter strings into their corresponding mathematical symbols.
- Variable-to-Symbol Mappings - Transforms Python variable names into Greek symbols and standard mathematical notation for better readability.
- LaTeX Math Rendering - Provides global preferences for decimal precision and scientific notation for LaTeX math rendering.
- Variable-to-Symbol Mappings - Translates Python variable names into Greek letters and subscripts using predefined replacement rules.
- Parametric Calculation Sheets - Creates automated reports that generate formatted mathematical calculations based on varying input parameters.
- Notation Converters - Transforms variable names into Greek symbols, subscripts, and prime notation while converting functions into operators.
- Function Decorators - Wraps functions with decorators to capture internal calculations for formatting.
- State Capture Decorators - Uses Python decorators to intercept local variable assignments and evaluations for rendering.
- Mathematical Operator Formatting - Converts Python function calls and custom operators into standard notation, such as using radical signs for square roots.
- Scientific Report Formatting - Generates formatted scientific reports showing both the mathematical formula and the numeric substitution.
- Equation Layout Customization - Adjusts the visual presentation of equations, including decimal precision and view toggles via tags.
- Calculation Annotation Integration - Displays source code comments as formatted annotations alongside rendered mathematical calculations.
- Automatic Mathematical Subscripts - Automatically creates LaTeX subscripts and nested subscripts based on the use of underscores in Python variable names.
- Calculation Step Recording - Captures and recalls calculation steps for specific iterations when processing data in tables.
- Mathematical Rendering Configurations - Sets session-wide formatting rules for decimal precision, LaTeX block delimiters, and scientific notation.
- Equation Renderers - Displays mathematical formulas without numeric substitutions to create purely symbolic equations.
- Calculation Context Documentation - Renders code comments as inline notes and uses conditional statements to provide context for mathematical results.
- Interactive Calculation Rendering - Generates formatted mathematics from code that updates in real-time based on interactive user input widgets.
- Symbolic Derivation Documentation - Combines symbolic algebra libraries with LaTeX to document complex mathematical derivations.
- Symbolic Engine Interoperability - Integrates with symbolic math engines to render algebraic expressions without forcing numeric evaluation.
- Rendering Integrations - Integrates with symbolic libraries like Sympy to handle algebraic expression substitution for rendering.
- Iteration Trace Recording - Stores calculation steps of repeated function calls to display specific iterations in a report.
- Jupyter Ecosystem - Rendering mathematical equations in notebook cells.
