Version: dev

Python API index

Every stable name Python exports, and its extension seams.

Package: earthsci_astdiff 0.1.0

Documentation extracted with griffe 2.3.2.

Extension-tier names are on the Python extension page .

Stable names

PythonCanonicalKindSummary
assemble_jacobianassemble_jacobianfunctionEvaluate the band entries at a point: {(rowname, colname): value} with contributions to one (row, col) pair SUMMED (§4 additivity, incl.
BandbandtypeOne structured block of ∂(rhs of the equation for u)/∂v — see the Julia reference docstring and esm-jacobian-spec.md §4.
BandErrorband_errorerrorRaised when an expression has a form the band calculus cannot differentiate (for example a filtered faq node or a non-"+" semiring).
BlockDiagonalPlanblock_diagonal_plantypePer-cell block LU of a block-diagonal Jacobian: the block variables in Markowitz order, the block pattern, the 1-based ordering and the pattern of the LU factors including fill-in.
cse_templatescse_templatesfunctionGreedy largest-first extraction of repeated subtrees.
DerivativeRuleErrorderivative_rule_errorerrorRaised when a scalar operator has no derivative rule (spec §3).
detect_structuredetect_structurefunctionClassify the band list: "block_diagonal", "banded", "general" (or "empty" / "other"), read off the column-index expressions without evaluating anything.
dscalardscalarfunctionDerivative of the scalar expression e w.r.t.
JacEntryjac_entrytypeOne block of the Jacobian: row variable u, column variable v, and the Band giving the rows it covers, the column-index expressions and the coefficient.
jacobian_bandsjacobian_bandsfunctionDifferentiate a model’s right-hand side into a list of Jacobian bands.
jacobian_blockjacobian_blockfunctionThe §4 jacobians block for one model: entries (template-CSE’d by default), the structure classification, and the block-local expression_templates, plus the factorization…
jacobian_patternjacobian_patternfunctionThe structural sparsity pattern as sorted (rowname, colname) pairs plus the entries — dependency-light (no scipy).
lu_filllu_fillfunctionSymbolic (no-pivoting) LU: the pattern plus every fill-in entry.
markowitz_orderingmarkowitz_orderingfunctionGreedy Markowitz ordering (1-based), first minimal cost wins.
plan_factorizationplan_factorizationfunctionSymbolic factorization info for the detected structure.
serialize_bandserialize_bandfunctionOne entry of the jacobians block, as a JSON-ready dict (spec §4).
simplify_branchessimplify_branchesfunctionLiteral-condition fold, equal-branch collapse, same-condition pruning.
SitesitetypeA bare variable reference or one symbolic index(v, i…) cell.
stable_jsonstable_jsonfunctionDeterministic JSON: sorted object keys at every level, floats in the reference’s layout (canonical_float) — emit.jl’s stable_json.
SysViewsys_viewtypeA model or flattened system as the band calculus sees it: its variables, equations and index sets, with subsystems already expanded.
sysviewsysviewfunctionView a model of an EsmFile, or a FlattenedSystem, for differentiation.