API Reference

Core Components

The following modules form the core of PathSim’s system definition and simulation capabilities.

🎯 Simulation

Main simulation engine that orchestrates system execution, manages blocks, connections, and events.

Simulation
🔌 Connection

Defines signal flow between blocks, enabling data transfer and system interconnection.

Connection
📦 Subsystem

Enables hierarchical modeling by encapsulating blocks and connections into reusable components.

Subsystem
🧱 Block Library

Comprehensive library of pre-built blocks for sources, operations, controllers, and more.

Block Library

Event System

PathSim’s event handling mechanism enables discrete event detection and system state modifications.

⚡ Event Library

Zero-crossing detection, scheduled events, and condition-based triggers for hybrid system simulation.

Event Library

Numerical Solvers

PathSim provides a wide range of ODE solvers with different characteristics and performance profiles.

hierarchy of PathSim numerical integrators
🔢 Solver Library

Explicit and implicit Runge-Kutta methods, BDF, Gear, and adaptive solvers for stiff and non-stiff problems.

Solver Library

Optimization & Differentiation

Advanced features for optimization and nonlinear solving.

🎓 Optimization Module

Nonlinear solvers and optimizers.

Optimization Module

Utilities

Helper functions and utility classes for analysis, plotting, and system management.

🛠️ Utility Functions

Analysis tools, real-time plotting, serialization, adaptive buffers, and more.

Utility Functions