Find an entry point by task. Each linked object page gives its full constructor signature, public methods/properties, parameters, return values, and exceptions. General analysis, batch, preset and time entries are imported from chronaxis; the integrator and custom operator sections state their respective import modules. See the result row models and developer reference (Chinese implementation references). For a complete file-based workflow, start with Python quick start.
Load and check a plan
Public name
Reference and purpose
chronaxis.AnalysisPlan
AnalysisPlan: Stores a session's analysis configuration and the objects produced by static checking.
chronaxis.load_analysis_plan
load_analysis_plan: Loads JSON/YAML and one level of shared definitions, resolving relative source paths against each declaring file.
chronaxis.validate_analysis_plan
validate_analysis_plan: Reports static configuration validity and current reader, execution, and publication limitations.
chronaxis.explain_analysis_plan
explain_analysis_plan: Lists dependencies, node calculations, required history, and declared budgets.
chronaxis.PlanValidationError
PlanValidationError: Contains the configuration path, reason, machine error code, and optional original source location and correction hint.
Run and read results
Public name
Reference and purpose
chronaxis.AnalysisRunner
AnalysisRunner: Stores an optional backend override, uses the same static validation, and creates independent resources for each run.
chronaxis.AnalysisResult
AnalysisResult: Stores staging paths and small metadata objects; it does not hold full lists of events, segments, or calculations.
chronaxis.OutputManifest
OutputManifest: Stores the successfully published directory, manifest, and row counts for the fixed table whitelist; legacy entries appear only when enabled.
chronaxis.ExportManifest
ExportManifest: Provides the actual directory, completion manifest, and data-file paths returned by direct signal-CSV or raw-message exports.
chronaxis.RunMetadata
RunMetadata: Stores run identity, actual backend, time interpretation, session boundaries, and compatibility limitations.
chronaxis.AnalysisError
AnalysisError: Signals an analysis or result-publication failure. The exception alone does not guarantee that old output was rolled back.
chronaxis.ResultClosedError
ResultClosedError: Signals that the result has been closed and can no longer create iterators, be read, or be published.
Batch execution
Public name
Reference and purpose
chronaxis.BatchPlan
BatchPlan: Stores batch options and independent jobs. Jobs reference a configuration path or a loaded analysis plan. Keep one continuous session in one job.
chronaxis.BatchJob
BatchJob: Declares one independent analysis. Continuous files belonging to the same session go in this job's single plan.
chronaxis.BatchJobResult
BatchJobResult: Stores the final status of a job. A close failure after publication still means failed, with the published path retained.
chronaxis.BatchReport
BatchReport: Lists results in original job order. Numerical tables remain in each job directory; values from separate jobs are not added together.
chronaxis.BatchRunner
BatchRunner: Uses process_count to select analysis workers. Each run creates and reclaims its workers; plans and state are not cached across batches.
chronaxis.load_batch_plan
load_batch_plan: Loads strict batch JSON/YAML. Takes a UTF-8 configuration path, returns BatchPlan, and raises configuration errors with paths.
chronaxis.run_batch
run_batch: Runs the batch and publishes its report.
PresetSpec: Stores a preset instance name, task type, template version, role-to-signal bindings, and business parameters. from_dict creates an immutable declaration.
chronaxis.PlanFragment
PlanFragment: Stores the public nodes generated by a preset, without sources, runners, or actual samples.
chronaxis.build_preset
build_preset: Validates a v1 preset and expands public declarations, without I/O or numerical analysis.
chronaxis.resolve_preset_roles
resolve_preset_roles: First uses explicit role_bindings. For unassigned roles, uses semantic_id and semantic_contract_version to find the unique signal satisfying each role.
Time conversion
Public name
Reference and purpose
chronaxis.TimeConversion
TimeConversion: Stores normalized time and source precision without sharing mutable conversion diagnostics across tasks.
chronaxis.TimeOverflowError
TimeOverflowError: Rejects time coordinates, shifted coordinates, or nonnegative spans outside int64.
chronaxis.checked_add_ns
checked_add_ns: Adds a fixed offset to one nanosecond coordinate and checks that the result remains in int64.
chronaxis.convert_time
convert_time: Converts an explicitly specified time unit to nanoseconds, rounding the final result to nearest, ties to even.
chronaxis.parse_datetime_ns
parse_datetime_ns: Converts a complete ISO date/time to integer UTC nanoseconds, preserving sub-microsecond fractions.
chronaxis.parse_duration
parse_duration: Parses a nonnegative duration with a unit, including an explicit zero duration.
chronaxis.shift_times_reference
shift_times_reference: Calculates each fixed offset independently as an integer reference for the array kernel.
chronaxis.time_deltas_reference
time_deltas_reference: Calculates adjacent spans in nondecreasing integer timestamps, allowing different samples at the same time.