Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Scientific contract registry

Unverified does not mean unsupported; it means no claim is registered. This generated page does not infer support from importability or an unrelated passing test.

Owner import path

jaxstro.contracts

Purpose

Expose the validated scientific-contract vocabulary, runtime inventory audit, and deterministic reference rendering.

Public records and callables

Contract enums and records, collect_contracts, audit_runtime_inventory, get_callable_contract, and get_module_contract.

Shape and dtype expectations

Contracts are immutable host-side metadata. They describe array, unit, transform, and evidence policies but do not contain runtime scientific arrays.

JAX transforms and AD classification

This tooling is host-side. The generated callable table records transform and AD claims owned by runtime modules.

Failure behavior

Invalid records, unresolved evidence, and runtime inventory drift fail validation instead of inferring support from importability.

Registered computational evidence resolves to the evidence index.

Canonical import example

from jaxstro.contracts import get_callable_contract

Module ownership

ModuleMaturityBoundaryDimensional policyOwnershipNon-ownership
jaxstro.astrometryvalidatedruntimeAngles in radians/degrees and proper motion in mas/yr as named.Astrometric constants.Survey or population models.
jaxstro.atmospheresvalidatedmixedSource coordinates and flux semantics are explicit per product.Catalog and artifact preparation plus evidence-gated evaluation.Photometry or model validity.
jaxstro.constantsvalidatedstaticCGS unless the symbol explicitly names another unit.Source-backed physical constants.Runtime source lookup.
jaxstro.contractsvalidatedtoolingMetadata only; scientific units are recorded by owned contracts.Scientific contract vocabulary, validation, and rendering.Runtime scientific acceptance or automatic certification.
jaxstro.coordsvalidatedruntimePositions in pc, velocities in km/s, angles in degrees, proper motions in mas/yr, and parallax in mas where documented.Coordinate transformations.Domain frame selection.
jaxstro.evidencevalidatedtoolingEvery metric carries explicit producer-owned units.Portable computational-evidence schemas, validation, and rendering.Method-specific scientific thresholds or source-provenance claims.
jaxstro.geometryvalidatedruntimeCaller-owned coordinate units; angles follow each function contract.Generic geometric transformations.Domain geometry policy.
jaxstro.jaxconfigvalidatedstaticNo physical dimensions.Explicit JAX precision configuration.Import-time global configuration.
jaxstro.numericsvalidatedruntimeCaller-owned units; each callable declares dimensional behavior.Generic numerical mechanics.Domain acceptance, retry policy, or physical state.
jaxstro.paramsvalidatedruntimeLeaf units remain caller-owned through transformations.Selective PyTree/vector parameter bridges.Inference algorithms or identifiability.
jaxstro.provenancevalidatedtoolingMetric units remain explicit in producer-owned payloads.Runtime artifact manifests.Scientific-source validation.
jaxstro.quadexperimentalruntimeRaw kernels with an alpha quantity adapter, heterogeneous coordinate normalization, and unit restoration owned only by quad.integrate.Canonical sampled-data integration, fixed and adaptive one-dimensional quadrature, finite-hyperrectangle tensor, cubature, sparse-grid, and randomized QMC methods, typed domains, measures, and result evidence.Non-hyperrectangular geometries, direct Quantity-PyTree quotient-unit Jacobians, higher derivatives, physical-model policy, inference, ODE solving, or scientific acceptance.
jaxstro.quantityvalidatedruntimeDimensions and scales are represented explicitly in Unit metadata.Dimensional quantity evaluation.Approved ecosystem adoption or cutover.
jaxstro.spatialvalidatedmixedCoordinates use caller-owned consistent length units.Spatial indexing, candidates, and exact pairs.Force or encounter semantics.
jaxstro.spectravalidatedmixedSpectral coordinates and density semantics carry explicit unit metadata.Generic spectral representations and remapping.Filters, photometry, or instruments.
jaxstro.testingvalidatedtoolingEvery reported metric retains producer-declared units.Validation and provenance tooling.Runtime scientific acceptance.
jaxstro.unitsvalidatedstaticCGS is canonical; named systems declare mass, length, and time scales.Canonical ecosystem unit systems.Hidden domain unit defaults.

Transform and AD contracts

CallableMaturityAD semanticsTransform claimsBoundariesEvidenceLimitations and cost
jaxstro.numerics.implicit_bracketed_rootvalidatedcertified_implicitjit: supportedRejected assumption or numerical certificate. [returns_nan]root.implicit_bracketed_root (validation_test); root.implicit_bracketed_root.certification (artifact) -> rootfinding.implicit-gradients gates exponential.absolute_residual.gate, exponential.bracket_width.gate, exponential.relative_ad_analytic_error.gate, exponential.relative_ad_fd_error.gate, exponential.slope_magnitude.gate, exponential.certificate.gate, linear.absolute_residual.gate, linear.bracket_width.gate, linear.relative_ad_analytic_error.gate, linear.relative_ad_fd_error.gate, linear.slope_magnitude.gate, linear.certificate.gate, quadratic.absolute_residual.gate, quadratic.bracket_width.gate, quadratic.relative_ad_analytic_error.gate, quadratic.relative_ad_fd_error.gate, quadratic.slope_magnitude.gate, quadratic.certificate.gateRequires a unique mathematical root.; Requires a smooth selected branch and adequate slope conditioning.; Runs the safeguarded primal before exposing a custom-root derivative.
jaxstro.numerics.initialize_bracketvalidatedvalue_firstnone claimednone registeredroot.initialize_bracket (unit_test)Primary purpose is auditable forward-value control flow.
jaxstro.numerics.interpolation.interp1dvalidatedsmooth_pathwisenone claimedQueries outside the table clamp to endpoint values. [saturates]numerics.interp1d (validation_test)AD evidence covers interior off-knot, branch-stable queries.
jaxstro.numerics.map_safeguarded_bracketed_rootvalidatedvalue_firstjit: supported; vmap: conditional (Values and shapes are preserved, but physical per-lane skipping is not guaranteed.)Missing sign bracket or nonfinite admissible evaluation. [structured_result]root.map_safeguarded_bracketed_root (unit_test); root.map_safeguarded_bracketed_root.performance (benchmark) -> rootfinding.performance gates flat_slope.hybrid-no-more-evaluations, linear.hybrid-no-more-evaluations, monotone_kink.hybrid-no-more-evaluations, oscillatory_fixed_point_residual.hybrid-no-more-evaluations, quadratic.hybrid-no-more-evaluationsNo implicit-root derivative claim.; Use lax.map when physical per-lane skipping of expensive residuals matters.
jaxstro.numerics.interpolation.monotone_cubic_interpvalidatedsmooth_pathwisenone claimednone registerednumerics.monotone_cubic_interp (validation_test)Sign, plateau, knot, and overshoot branch boundaries are nonsmooth.
jaxstro.numerics.powerlaw_cdfvalidatedsmooth_pathwisenone claimedOutside x support clamps to zero or one. [saturates]numerics.powerlaw_cdf (validation_test)none registered
jaxstro.numerics.powerlaw_logpdfvalidatedsmooth_pathwisenone claimedOutside x support returns negative infinity. [returns_sentinel]numerics.powerlaw_logpdf (validation_test)none registered
jaxstro.numerics.powerlaw_ppfvalidatedsmooth_pathwisenone claimedQuantile input is defined on the closed unit interval. [undefined]numerics.powerlaw_ppf (validation_test)none registered
jaxstro.numerics.propose_bracketedvalidatedvalue_firstnone claimednone registeredroot.propose_bracketed (unit_test)Primary purpose is auditable forward-value control flow.
jaxstro.numerics.regular_grid_interpvalidatedsmooth_pathwisenone claimedclamp policy holds queries at the nearest boundary. [saturates]; reject policy raises for invalid concrete queries. [raises]numerics.regular_grid_interp (validation_test)Coordinate derivatives are claimed only inside branch-stable cells.
jaxstro.numerics.safeguarded_bracketed_rootvalidatedvalue_firstjit: supported; vmap: conditional (Values and shapes are preserved, but physical per-lane skipping is not guaranteed.)Missing sign bracket or nonfinite admissible evaluation. [structured_result]root.safeguarded_bracketed_root (unit_test); root.safeguarded_bracketed_root.public-validation (validation_test); root.safeguarded_bracketed_root.performance (benchmark) -> rootfinding.performance gates flat_slope.hybrid-no-more-evaluations, linear.hybrid-no-more-evaluations, monotone_kink.hybrid-no-more-evaluations, oscillatory_fixed_point_residual.hybrid-no-more-evaluations, quadratic.hybrid-no-more-evaluationsNo implicit-root derivative claim.; Use lax.map when physical per-lane skipping of expensive residuals matters.
jaxstro.numerics.universal_kepler_stepvalidatedsmooth_pathwisejit: supported; vmap: supported; jvp: conditional (Continuous state on one converged route with fixed shape, iteration budget, status path, and Stumpff branch.); vjp: conditional (Continuous state on one converged route with fixed shape, iteration budget, status path, and Stumpff branch.)Invalid input, nonfinite iteration, singular radius, or exhausted iteration budget. [structured_result]numerics.universal_kepler_step.value (unit_test); numerics.universal_kepler_step.fixed_route_ad (validation_test)No derivative claim across status, iteration-count, Stumpff-route, conic-label, or collision boundaries.; No implicit-root derivative claim; AD follows the finite executed Newton map.; Units, object identity, encounter selection, and state-commit policy belong to callers.; Runs a fixed 12-slot Newton scan by default; converged lanes freeze numerically.
jaxstro.numerics.update_bracketvalidatedvalue_firstnone claimednone registeredroot.update_bracket (unit_test)Primary purpose is auditable forward-value control flow.
jaxstro.quad.fixedexperimentalsmooth_pathwisejax.jit: supported (Rule type, rule order or level, measure type, breakpoint count, and payload shape remain static.); jax.vmap: supported (Batch explicit arguments or numerical bounds.)Unsupported rule, domain, and measure pairings raise eagerly. [raises]; Value-dependent invalid finite domains return NaN under tracing. [returns_nan]quad-fixed-unit (unit_test); quad-fixed-transforms (integration_test)A fixed rule does not estimate truncation error or select its order.; Quantity-valued fixed integration is not implemented.; Integrand work is the static node count multiplied by the static number of finite breakpoint segments.
jaxstro.quad.integrateexperimentalsmooth_pathwisejax.jit: supported (Method configuration, dimension, capacities, breakpoint count, payload shape, QMC schedule, and scramble family remain static.); jax.vmap: supported (Each batch member runs one independent bounded controller or formula; cost-sensitive heterogeneous cubature batches should use lax.map for physical per-lane skipping.); jvp: conditional (First-order accepted-formula replay of value with parameters passed through explicit args or supported smooth bounds; controller decisions, accepted structures, confidence construction, and diagnostics are stopped.); vjp: conditional (Project value or a floating diagnostic; full integer-bearing result Jacobians are outside the contract.); jacfwd/jacrev: conditional (Apply to value only, using JAX realified conventions for complex maps.)Unsupported method, domain, measure, breakpoint, or capacity declarations raise eagerly. [raises]; Dynamic invalid, nonfinite, roundoff-limited, or exhausted cases return a typed status. [structured_result]quad-adaptive-transforms (integration_test); quad-adaptive-validation (validation_test); quad-adaptive-envelope (artifact); quad-adaptive-replay (validation_test); quad-replay-derivatives (artifact); quad-adaptive-quantity (integration_test); quad-performance (artifact); quad-multidim-truth (artifact); quad-multidim-replay (artifact); quad-rqmc-calibration (artifact); quad-multidim-comparisons (artifact); quad-multidim-performance (artifact); quad-multidim-observed-memory (artifact)Estimator convergence is not a universal bound on true error.; Related rules can miss the same unresolved narrow feature.; Replay is the default first-order derivative of the accepted fixed formula; gradient=stop remains explicit.; Quantity-aware adaptive integration is alpha and opt-in.; Dimensional improper domains require an explicit positive physical scale.; Direct Quantity-PyTree quotient-unit Jacobians and higher derivatives are not claimed.; Multidimensional geometry is restricted to finite hyperrectangles.; TensorProduct and deterministic Sobol provide no runtime error estimate.; Adaptive tensor, cubature, and sparse-grid estimators are method-specific numerical evidence, not universal true-error bounds.; Randomized confidence intervals require real scalar outputs and the declared independent scramble construction.; The frozen CPU process-RSS campaign found no material replay increment; the active backend exposes no separate device-memory metric.; No universal performance-superiority claim is established.; Regional logical work is node_count * (initial_regions + 2 * refinements); global methods report their finest completed active grid, sparse methods report unique nodes, and QMC reports point-integrand evaluations across all accepted replicates.
jaxstro.testing.compare_gradientsvalidatedvalidation_onlynone claimednone registeredtesting.compare_gradients (integration_test)Does not determine downstream scientific acceptance.
jaxstro.testing.render_registryvalidatedvalidation_onlynone claimednone registeredtesting.render_registry (integration_test)Does not determine downstream scientific acceptance.
jaxstro.testing.validate_cardvalidatedvalidation_onlynone claimednone registeredtesting.validate_card (integration_test)Does not determine downstream scientific acceptance.

Unclassified callable surfaces

The runtime export audit found 235 public callables without callable-level records:

The absence from the table is not a support or maturity claim.

Module-inherited public types

These immutable record or type constructors inherit their module-level contract:

Research infrastructure
JAX configuration
Research infrastructure
Computational evidence