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.

pathsim.simulation
🔌 Connection

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

pathsim.connection
📦 Subsystem

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

pathsim.subsystem
🧱 Block Library

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

pathsim.blocks

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.

pathsim.events

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.

pathsim.solvers

Optimization & Differentiation

Advanced features for optimization and nonlinear solving.

🎓 Optimization Module

Nonlinear solvers and optimizers.

pathsim.optim

Utilities

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

🛠️ Utility Functions

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

pathsim.utils