hekatan

Python display library for engineering calculations — equations, matrices, figures, academic papers.

hekatan turns your Python engineering scripts into publication-quality HTML documents — with proper math notation, matrices with brackets, fraction bars, integrals, summations, design checks, and academic paper layouts. Zero dependencies. No LaTeX required.

Installation

pip install hekatan

Requires Python 3.8+. No external dependencies.

Quick Start

from hekatan import matrix, eq, var, fraction, title, text, check, show

title("Beam Design")
text("Rectangular section properties:")

var("b", 300, "mm", "beam width")
var("h", 500, "mm", "beam height")
eq("A", 300 * 500, "mm^2")

title("Stiffness Matrix", level=2)
K = [[12, 6, -12, 6],
     [6, 4, -6, 2],
     [-12, -6, 12, -6],
     [6, 2, -6, 4]]
matrix(K, "K")

title("Design Check", level=2)
fraction("M_u", "phi * b * d^2", "R_n")
check("sigma", 150, 250, "MPa")  # 150 <= 250 -> OK

show()  # Opens formatted HTML in your browser

Rich Equations

The eq_block() function renders equations with fractions, integrals, summations, and equation numbers — using Hekatan Calc notation:

from hekatan import eq_block, show

# Fractions: (numerator)/(denominator) with recursive nesting
eq_block("k = (E * A)/(L)  (1)")

# Integrals with limits
eq_block("∫_{a}^{b} f(x)*dx = F(b) - F(a)  (5.5)")

# Summation
eq_block("A = Σ_{i=1}^{N} f_i * Delta*x  (5.2)")

# Nested fractions + integrals
eq_block("I = ∫_{0}^{1} (1)/(e^{3x})*dx ≈ 0.3167  (5.13)")

# Partial derivatives as fractions
eq_block("(∂^2M_x)/(∂x^2) + (∂^2M_y)/(∂y^2) + q = 0  (1.1)")

# Multiple equations at once
eq_block(
    "sigma = (N)/(A) + (M * y)/(I_z)  (2)",
    "epsilon = (partial u)/(partial x)  (3)",
)

show()

Equation Number Syntax

Equation numbers are placed at the end with 2+ spaces before the parenthesized number:

eq_block("F = m*a  (1)")              # Simple: (1)
eq_block("D = (E*h^3)/(12)  (1.3)")   # Dotted: (1.3)
eq_block("N_x = ∫ sigma_x*dz  (1.5a)")  # With suffix: (1.5a)

Subscript & Superscript Rules

Academic Paper Layout

Create publication-quality documents with paper configuration, headers, footers, author blocks, abstracts, and multi-column layouts:

from hekatan import (
    paper, header, footer, author, abstract_block,
    title, heading, text, markdown, eq_block, figure,
    columns, column, end_columns, table, show, clear,
)

clear()

# Paper config: page size, fonts, accent color
paper(
    size="A4",
    margin="20mm 18mm 25mm 18mm",
    fontsize="10pt",
    accent="#F27835",
)

# Header bar
header(left="Journal of Civil Engineering", right="Vol 70, 2018")

# Title and authors
title("Method of Incompatible Modes")
author("Ivo Kozar", "University of Rijeka, Croatia")

# Abstract with keywords
abstract_block(
    "This paper presents the method of incompatible modes...",
    keywords=["finite elements", "incompatible modes"],
    lang="english",
)

# Two-column layout (CSS multi-column flow)
columns(2, css_columns=True)
heading("1. Introduction", 2)
markdown("""
The **finite element method** is based on:
- Weak formulation
- Shape functions
- Assembly procedure
""")

# Rich equations
eq_block("u(x) = N(x) * d + M(x) * alpha  (1)")

# SVG figures with captions
figure('<svg width="400" height="200">...</svg>',
       caption="Beam element with shape functions",
       number="1", width="90%")
end_columns()

show("paper_output.html")

How It Works

Each function works in 3 modes (auto-detected):

Mode is auto-detected via HEKATAN_RENDER=1 environment variable. You can force a mode with set_mode("standalone"), set_mode("hekatan"), or set_mode("console").

API Reference

Core Math

Calculus Operators

Paper Layout

Text & Content

Layout

Control

Features

• Zero dependencies — pure Python, no NumPy/LaTeX/MathJax required
• Greek letters — auto-converts alpha, sigma, phi, Delta, etc. to symbols
• Subscripts/superscripts — A_s renders as subscript, x^2 as superscript
• Braced notation — A_{steel}, x^{2n} for multi-character sub/superscripts
• Smart superscript — ^ only consumes digits (∂^2M stays correct), use ^{x} for letters
• Word-boundary safe — Greek replacement won't corrupt Spanish/Portuguese words
• Recursive fractions — (a + (b)/(c))/(d) renders nested fraction bars
• Integrals — ∫_{a}^{b} renders with proper limits above/below
• Summation — Σ_{i=1}^{N} renders with limits above/below
• Equation numbers — (1.1), (1.5a), (2.3b) all supported
• CSS columns — flex-based (manual breaks) and CSS multi-column (auto-flow) layouts
• Column proportions — columns(2, "32:68") for asymmetric layouts
• Page breaks with headers — running headers on each page
• Print-ready — @page CSS rules for PDF export via browser print
• Design checks — pass/fail verification with color-coded output

Integration with Hekatan Calc

When used inside a Hekatan Calc .hcalc document:

# My Calculation

@{python}
from hekatan import matrix, eq, eq_block

K = [[12, 6], [6, 4]]
matrix(K, "K")
eq("det_K", 12*4 - 6*6)
eq_block("sigma = (M * y)/(I_z)  (1)")
@{end python}

The output is automatically formatted with Hekatan Calc's CSS — matrices with brackets, equations with proper serif typography, fraction bars, integral symbols, and more.

Example: FEA Slab Analysis

The examples/ directory includes a full finite element analysis of a rectangular slab using the BFS plate bending element (585 lines). It demonstrates variables, equations, matrices, tables, partial derivatives, double integrals, and design checks — all rendered as a single HTML document.

cd examples
python rectangular_slab_fea.py

License

MIT