API Reference

The basic object hierarchy of PathSim is shown in the diagramm below.

System Definition and Simulation

The following modules serve the system definition and simulation.

Simulation

• pathsim.simulation
  • Simulation
    • Simulation.time
    • Simulation.path_length
    • Simulation.engine
    • Simulation.logger
    • Simulation.plot()
    • Simulation.save()
    • Simulation.load()
    • Simulation.to_dict()
    • Simulation.from_dict()
    • Simulation.add_block()
    • Simulation.add_connection()
    • Simulation.add_event()
    • Simulation.reset()
    • Simulation.linearize()
    • Simulation.delinearize()
    • Simulation.steadystate()
    • Simulation.step_fixed()
    • Simulation.step_adaptive()
    • Simulation.step()
    • Simulation.run()

Subsystem

• pathsim.subsystem
  • Interface
    • Interface.set_output()
    • Interface.get_input()
  • Subsystem
    • Subsystem.interface
    • Subsystem.plot()
    • Subsystem.reset()
    • Subsystem.on()
    • Subsystem.off()
    • Subsystem.linearize()
    • Subsystem.delinearize()
    • Subsystem.to_dict()
    • Subsystem.from_dict()
    • Subsystem.get_events()
    • Subsystem.set()
    • Subsystem.get()
    • Subsystem.sample()
    • Subsystem.update()
    • Subsystem.solve()
    • Subsystem.step()
    • Subsystem.set_solver()
    • Subsystem.revert()
    • Subsystem.buffer()

Connections

• pathsim.connection
  • Connection
    • Connection.on()
    • Connection.off()
    • Connection.overwrites()
    • Connection.to_dict()
    • Connection.update()
  • Duplex
    • Duplex.to_dict()
    • Duplex.update()

Blocks

• pathsim.blocks
  • pathsim.blocks._block module
    • Block
      • Block.inputs
      • Block.outputs
      • Block.engine
      • Block.events
      • Block._active
      • Block.op_alg
      • Block.op_dyn
      • Block.plot()
      • Block.on()
      • Block.off()
      • Block.reset()
      • Block.linearize()
      • Block.delinearize()
      • Block.get_events()
      • Block.set_solver()
      • Block.revert()
      • Block.buffer()
      • Block.sample()
      • Block.get_all()
      • Block.set()
      • Block.get()
      • Block.update()
      • Block.solve()
      • Block.step()
  • pathsim.blocks.adder module
    • Adder
      • Adder._ops
      • Adder._ops_array
      • Adder.op_alg
      • Adder.update()
  • pathsim.blocks.amplifier module
    • Amplifier
      • Amplifier.op_alg
      • Amplifier.update()
  • pathsim.blocks.delay module
    • Delay
      • Delay._buffer
      • Delay.reset()
      • Delay.update()
      • Delay.sample()
  • pathsim.blocks.differentiator module
    • Differentiator
      • Differentiator.op_dyn
      • Differentiator.op_alg
      • Differentiator.set_solver()
      • Differentiator.update()
      • Differentiator.solve()
      • Differentiator.step()
  • pathsim.blocks.function module
    • Function
      • Function.op_alg
      • Function.update()
  • pathsim.blocks.integrator module
    • Integrator
      • Integrator.set_solver()
      • Integrator.update()
      • Integrator.solve()
      • Integrator.step()
  • pathsim.blocks.lti module
    • StateSpace
      • StateSpace.op_dyn
      • StateSpace.op_alg
      • StateSpace.set_solver()
      • StateSpace.solve()
      • StateSpace.step()
    • TransferFunction
  • pathsim.blocks.multiplier module
    • Multiplier
      • Multiplier.op_alg
      • Multiplier.update()
  • pathsim.blocks.ode module
    • ODE
      • ODE.op_dyn
      • ODE.set_solver()
      • ODE.update()
      • ODE.solve()
      • ODE.step()
  • pathsim.blocks.rng module
    • RNG
      • RNG.n_samples
      • RNG.val
      • RNG.reset()
      • RNG.sample()
      • RNG.update()
  • pathsim.blocks.scope module
    • Scope
      • Scope.recording
      • Scope.reset()
      • Scope.read()
      • Scope.sample()
      • Scope.plot()
      • Scope.plot2D()
      • Scope.plot3D()
      • Scope.save()
      • Scope.update()
    • RealtimeScope
      • RealtimeScope.plotter
      • RealtimeScope.sample()
  • pathsim.blocks.sources module
    • Constant
      • Constant.update()
    • Source
      • Source.update()
  • pathsim.blocks.switch module
    • Switch
      • Switch.select()
      • Switch.update()
  • pathsim.blocks.spectrum module
    • Spectrum
      • Spectrum.set_solver()
      • Spectrum.reset()
      • Spectrum.read()
      • Spectrum.solve()
      • Spectrum.step()
      • Spectrum.plot()
      • Spectrum.save()
      • Spectrum.update()
    • RealtimeSpectrum
      • RealtimeSpectrum.step()
  • pathsim.blocks.mixed
    • pathsim.blocks.mixed.comparator module
      • Comparator
        • Comparator.events
        • Comparator.update()
    • pathsim.blocks.mixed.converters module
      • ADC
        • ADC.events
      • DAC
        • DAC.events
    • pathsim.blocks.mixed.samplehold module
      • SampleHold
        • SampleHold.events
    • pathsim.blocks.mixed.sources module
      • Clock
        • Clock.events
      • SquareWave
        • SquareWave.events
      • Step
        • Step.events
    • pathsim.blocks.mixed.fir module
      • FIR
        • FIR.buffer
        • FIR.events
        • FIR.reset()
  • pathsim.blocks.ctrl module
    • PID
      • PID.op_dyn
      • PID.op_alg
      • PID.set_solver()
      • PID.update()
      • PID.solve()
      • PID.step()
    • AntiWindupPID
      • AntiWindupPID.op_dyn
      • AntiWindupPID.op_alg
  • pathsim.blocks.rf
    • pathsim.blocks.rf.filters module
      • ButterworthLowpassFilter
      • ButterworthHighpassFilter
      • ButterworthBandpassFilter
      • ButterworthBandstopFilter
      • AllpassFilter
    • pathsim.blocks.rf.noise module
      • WhiteNoise
        • WhiteNoise.sigma
        • WhiteNoise.n_samples
        • WhiteNoise.reset()
        • WhiteNoise.sample()
        • WhiteNoise.update()
      • PinkNoise
        • PinkNoise.sigma
        • PinkNoise.n_samples
        • PinkNoise.noise
        • PinkNoise.octaves_values
        • PinkNoise.reset()
        • PinkNoise.sample()
        • PinkNoise.update()
      • SinusoidalPhaseNoiseSource
        • SinusoidalPhaseNoiseSource.set_solver()
        • SinusoidalPhaseNoiseSource.reset()
        • SinusoidalPhaseNoiseSource.update()
        • SinusoidalPhaseNoiseSource.sample()
        • SinusoidalPhaseNoiseSource.solve()
        • SinusoidalPhaseNoiseSource.step()
    • pathsim.blocks.rf.sources module
      • gaussian()
      • triangle_wave()
      • square_wave()
      • SquareWaveSource
        • SquareWaveSource.update()
      • TriangleWaveSource
        • TriangleWaveSource.update()
      • SinusoidalSource
        • SinusoidalSource.update()
      • GaussianPulseSource
        • GaussianPulseSource.update()
      • StepSource
        • StepSource.update()
      • ChirpSource
        • ChirpSource.reset()
        • ChirpSource.set_solver()
        • ChirpSource.sample()
        • ChirpSource.update()
        • ChirpSource.solve()
        • ChirpSource.step()

Events

• pathsim.events
  • pathsim.events._event module
    • Event
      • Event._history
      • Event._times
      • Event._active
      • Event.on()
      • Event.off()
      • Event.reset()
      • Event.buffer()
      • Event.detect()
      • Event.resolve()
  • pathsim.events.condition module
    • Condition
      • Condition.detect()
      • Condition.resolve()
  • pathsim.events.schedule module
    • Schedule
      • Schedule.buffer()
      • Schedule.detect()
  • pathsim.events.zerocrossing module
    • ZeroCrossing
      • ZeroCrossing.detect()
    • ZeroCrossingUp
      • ZeroCrossingUp.detect()
    • ZeroCrossingDown
      • ZeroCrossingDown.detect()

ODE Solvers

The numerical ODE solvers, available in PathSim are structured like this:

Solvers

• pathsim.solvers
  • pathsim.solvers._solver module
    • Solver
      • Solver.x_0
      • Solver.x
      • Solver.n
      • Solver.s
      • Solver.stage
      • Solver.eval_stages
      • Solver.stages()
      • Solver.get()
      • Solver.set()
      • Solver.reset()
      • Solver.buffer()
      • Solver.cast()
      • Solver.error_controller()
      • Solver.revert()
      • Solver.step()
      • Solver.interpolate()
    • ExplicitSolver
      • ExplicitSolver.x_0
      • ExplicitSolver.x
      • ExplicitSolver.n
      • ExplicitSolver.s
      • ExplicitSolver.stage
      • ExplicitSolver.eval_stages
      • ExplicitSolver.integrate_singlestep()
      • ExplicitSolver.integrate()
    • ImplicitSolver
      • ImplicitSolver.x_0
      • ImplicitSolver.x
      • ImplicitSolver.n
      • ImplicitSolver.s
      • ImplicitSolver.stage
      • ImplicitSolver.eval_stages
      • ImplicitSolver.opt
      • ImplicitSolver.buffer()
      • ImplicitSolver.solve()
      • ImplicitSolver.integrate_singlestep()
      • ImplicitSolver.integrate()
  • pathsim.solvers._rungekutta module
    • ExplicitRungeKutta
      • ExplicitRungeKutta.n
      • ExplicitRungeKutta.m
      • ExplicitRungeKutta.s
      • ExplicitRungeKutta.beta
      • ExplicitRungeKutta.Ks
      • ExplicitRungeKutta.BT
      • ExplicitRungeKutta.TR
      • ExplicitRungeKutta.error_controller()
      • ExplicitRungeKutta.step()
    • DiagonallyImplicitRungeKutta
      • DiagonallyImplicitRungeKutta.n
      • DiagonallyImplicitRungeKutta.m
      • DiagonallyImplicitRungeKutta.s
      • DiagonallyImplicitRungeKutta.beta
      • DiagonallyImplicitRungeKutta.Ks
      • DiagonallyImplicitRungeKutta.BT
      • DiagonallyImplicitRungeKutta.A
      • DiagonallyImplicitRungeKutta.TR
      • DiagonallyImplicitRungeKutta.error_controller()
      • DiagonallyImplicitRungeKutta.solve()
      • DiagonallyImplicitRungeKutta.step()
  • pathsim.solvers.euler module
    • EUF
      • EUF.step()
    • EUB
      • EUB.solve()
  • pathsim.solvers.ssprk22 module
    • SSPRK22
      • SSPRK22.interpolate()
  • pathsim.solvers.ssprk33 module
    • SSPRK33
      • SSPRK33.interpolate()
  • pathsim.solvers.ssprk34 module
    • SSPRK34
  • pathsim.solvers.rk4 module
    • RK4
      • RK4.interpolate()
  • pathsim.solvers.rkbs32 module
    • RKBS32
  • pathsim.solvers.rkck54 module
    • RKCK54
  • pathsim.solvers.rkdp54 module
    • RKDP54
  • pathsim.solvers.rkdp87 module
    • RKDP87
  • pathsim.solvers.rkf21 module
    • RKF21
  • pathsim.solvers.rkf45 module
    • RKF45
  • pathsim.solvers.rkf78 module
    • RKF78
  • pathsim.solvers.rkv65 module
    • RKV65
  • pathsim.solvers.bdf module
    • BDF
      • BDF.x_0
      • BDF.x
      • BDF.n
      • BDF.s
      • BDF.stage
      • BDF.eval_stages
      • BDF.opt
      • BDF.K
      • BDF.F
      • BDF.B
      • BDF.reset()
      • BDF.buffer()
      • BDF.solve()
    • BDF2
    • BDF3
    • BDF4
    • BDF5
    • BDF6
  • pathsim.solvers.gear module
    • compute_bdf_coefficients()
    • GEAR
      • GEAR.reset()
      • GEAR.buffer()
      • GEAR.revert()
      • GEAR.error_controller()
      • GEAR.solve()
      • GEAR.step()
    • GEAR21
    • GEAR32
    • GEAR43
    • GEAR54
    • GEAR52A
      • GEAR52A.buffer()
      • GEAR52A.error_controller()
      • GEAR52A.step()
  • pathsim.solvers.dirk2 module
    • DIRK2
  • pathsim.solvers.dirk3 module
    • DIRK3
  • pathsim.solvers.esdirk32 module
    • ESDIRK32
  • pathsim.solvers.esdirk4 module
    • ESDIRK4
  • pathsim.solvers.esdirk43 module
    • ESDIRK43
  • pathsim.solvers.esdirk54 module
    • ESDIRK54
  • pathsim.solvers.esdirk85 module
    • ESDIRK85
  • pathsim.solvers.steadystate module
    • SteadyState
      • SteadyState.solve()

Optimizers and Automatic Differentiation

The pathsim.optim module contains a range of nonlinear solvers / optimizers that are primarily used for the implicit update equation of implicit ODE solvers and for the steadystate solver. This module also includes the automatic differentiation framework.

Optim

• pathsim.optim
  • pathsim.optim.anderson module
    • Anderson
      • Anderson.solve()
      • Anderson.reset()
      • Anderson.step()
    • NewtonAnderson
      • NewtonAnderson.solve()
      • NewtonAnderson.step()
  • pathsim.optim.value module
    • der()
    • jac()
    • var()
    • autojac()
    • add_funcs()
    • Value
      • Value._id
      • Value.val
      • Value.grad
      • Value.sig
      • Value.real
      • Value.imag
      • Value.numeric()
      • Value.array()
      • Value.der()
      • Value.jac()
      • Value.var()
      • Value.absolute
      • Value.angle()
      • Value.arccos
      • Value.arccosh
      • Value.arcsin
      • Value.arcsinh
      • Value.arctan
      • Value.arctanh
      • Value.cbrt
      • Value.conjugate
      • Value.cos
      • Value.cosh
      • Value.exp
      • Value.exp2
      • Value.expm1
      • Value.log
      • Value.log10
      • Value.log1p
      • Value.log2
      • Value.power
      • Value.sign
      • Value.sin
      • Value.sinh
      • Value.sqrt
      • Value.square
      • Value.tan
      • Value.tanh
  • pathsim.optim.numerical module
    • num_jac()
    • num_autojac()
  • pathsim.optim.operator module
    • Operator
      • Operator.f0
      • Operator.x0
      • Operator.J
      • Operator.jac()
      • Operator.linearize()
      • Operator.reset()
    • DynamicOperator
      • DynamicOperator.f0
      • DynamicOperator.x0
      • DynamicOperator.u0
      • DynamicOperator.Jx
      • DynamicOperator.Ju
      • DynamicOperator.jac_x()
      • DynamicOperator.jac_u()
      • DynamicOperator.linearize()
      • DynamicOperator.reset()

Utilities

Utility functions and classes.

Utils

• pathsim.utils
  • pathsim.utils.adaptivebuffer module
    • AdaptiveBuffer
      • AdaptiveBuffer.buffer_t
      • AdaptiveBuffer.buffer_v
      • AdaptiveBuffer.ns
      • AdaptiveBuffer.add()
      • AdaptiveBuffer.interp()
      • AdaptiveBuffer.get()
      • AdaptiveBuffer.clear()
  • pathsim.utils.analysis module
    • Timer
    • timer()
    • Profiler
  • pathsim.utils.gilbert module
    • gilbert_realization()
  • pathsim.utils.progresstracker module
    • ProgressTracker
      • ProgressTracker.check()
  • pathsim.utils.realtimeplotter module
    • RealtimePlotter
      • RealtimePlotter.fig
      • RealtimePlotter.ax
      • RealtimePlotter.update_all()
      • RealtimePlotter.update()
      • RealtimePlotter.show()
      • RealtimePlotter.on_close()
  • pathsim.utils.serialization module
    • serialize_callable()
    • serialize_object()
    • deserialize()
    • Serializable
      • Serializable.save()
      • Serializable.load()
      • Serializable.from_dict()
      • Serializable.to_dict()
  • pathsim.utils.utils module
    • dict_to_array()
    • array_to_dict()
    • rel_error()
    • abs_error()
    • max_error()
    • max_rel_error()
    • max_error_dicts()
    • max_rel_error_dicts()
    • path_length_dfs()