Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
SymBRiM documentation
SymBRiM documentation
  • User Guide
    • Installation
    • Introduction to SymBRiM
    • Guidelines on Implementing Components
  • Tutorials
    • Four-bar Linkage
    • Building Bicycle-Rider Models with SymBRiM
    • Rolling Disc From Scratch
  • Contributing
  • API Reference
    • symbrim.brim
      • symbrim.brim.base_connections
        • symbrim.brim.base_connections.HandGripsBase
        • symbrim.brim.base_connections.PedalsBase
        • symbrim.brim.base_connections.SeatBase
      • symbrim.brim.bicycle_rider
        • symbrim.brim.bicycle_rider.BicycleRider
      • symbrim.brim.hand_grips
        • symbrim.brim.hand_grips.HolonomicHandGrips
        • symbrim.brim.hand_grips.SpringDamperHandGrips
      • symbrim.brim.pedals
        • symbrim.brim.pedals.HolonomicPedals
        • symbrim.brim.pedals.SpringDamperPedals
      • symbrim.brim.seats
        • symbrim.brim.seats.FixedSeat
        • symbrim.brim.seats.PelvisInterPointMixin
        • symbrim.brim.seats.SideLeanSeat
        • symbrim.brim.seats.SideLeanSeatSpringDamper
        • symbrim.brim.seats.SideLeanSeatTorque
    • symbrim.bicycle
      • symbrim.bicycle.bicycle_base
        • symbrim.bicycle.bicycle_base.BicycleBase
      • symbrim.bicycle.cranks
        • symbrim.bicycle.cranks.CranksBase
        • symbrim.bicycle.cranks.MasslessCranks
      • symbrim.bicycle.front_frames
        • symbrim.bicycle.front_frames.FrontFrameBase
        • symbrim.bicycle.front_frames.RigidFrontFrame
        • symbrim.bicycle.front_frames.RigidFrontFrameMoore
        • symbrim.bicycle.front_frames.SuspensionRigidFrontFrame
        • symbrim.bicycle.front_frames.SuspensionRigidFrontFrameMoore
      • symbrim.bicycle.grounds
        • symbrim.bicycle.grounds.FlatGround
        • symbrim.bicycle.grounds.GroundBase
      • symbrim.bicycle.rear_frames
        • symbrim.bicycle.rear_frames.RearFrameBase
        • symbrim.bicycle.rear_frames.RigidRearFrame
        • symbrim.bicycle.rear_frames.RigidRearFrameMoore
      • symbrim.bicycle.stationary_bicycle
        • symbrim.bicycle.stationary_bicycle.StationaryBicycle
      • symbrim.bicycle.tires
        • symbrim.bicycle.tires.InContactTire
        • symbrim.bicycle.tires.NonHolonomicTire
        • symbrim.bicycle.tires.TireBase
      • symbrim.bicycle.wheels
        • symbrim.bicycle.wheels.KnifeEdgeWheel
        • symbrim.bicycle.wheels.ToroidalWheel
        • symbrim.bicycle.wheels.WheelBase
      • symbrim.bicycle.whipple_bicycle
        • symbrim.bicycle.whipple_bicycle.WhippleBicycle
        • symbrim.bicycle.whipple_bicycle.WhippleBicycleMoore
    • symbrim.rider
      • symbrim.rider.arms
        • symbrim.rider.arms.ArmBase
        • symbrim.rider.arms.LeftArmBase
        • symbrim.rider.arms.PinElbowSpringDamper
        • symbrim.rider.arms.PinElbowStickArmMixin
        • symbrim.rider.arms.PinElbowStickLeftArm
        • symbrim.rider.arms.PinElbowStickRightArm
        • symbrim.rider.arms.PinElbowTorque
        • symbrim.rider.arms.RightArmBase
      • symbrim.rider.base_connections
        • symbrim.rider.base_connections.HipBase
        • symbrim.rider.base_connections.LeftHipBase
        • symbrim.rider.base_connections.LeftShoulderBase
        • symbrim.rider.base_connections.RightHipBase
        • symbrim.rider.base_connections.RightShoulderBase
        • symbrim.rider.base_connections.SacrumBase
        • symbrim.rider.base_connections.ShoulderBase
      • symbrim.rider.hip_joints
        • symbrim.rider.hip_joints.PinHipMixin
        • symbrim.rider.hip_joints.PinLeftHip
        • symbrim.rider.hip_joints.PinRightHip
        • symbrim.rider.hip_joints.SphericalHipMixin
        • symbrim.rider.hip_joints.SphericalHipSpringDamper
        • symbrim.rider.hip_joints.SphericalHipTorque
        • symbrim.rider.hip_joints.SphericalLeftHip
        • symbrim.rider.hip_joints.SphericalRightHip
      • symbrim.rider.legs
        • symbrim.rider.legs.LeftLegBase
        • symbrim.rider.legs.LegBase
        • symbrim.rider.legs.RightLegBase
        • symbrim.rider.legs.TwoPinLegSpringDamper
        • symbrim.rider.legs.TwoPinLegTorque
        • symbrim.rider.legs.TwoPinStickLeftLeg
        • symbrim.rider.legs.TwoPinStickLegMixin
        • symbrim.rider.legs.TwoPinStickRightLeg
      • symbrim.rider.pelvis
        • symbrim.rider.pelvis.PelvisBase
        • symbrim.rider.pelvis.PlanarPelvis
      • symbrim.rider.rider
        • symbrim.rider.rider.Rider
      • symbrim.rider.rider_lean
        • symbrim.rider.rider_lean.RiderLean
        • symbrim.rider.rider_lean.RiderLeanConnection
      • symbrim.rider.sacrums
        • symbrim.rider.sacrums.FixedSacrum
      • symbrim.rider.shoulder_joints
        • symbrim.rider.shoulder_joints.FlexAddLeftShoulder
        • symbrim.rider.shoulder_joints.FlexAddRightShoulder
        • symbrim.rider.shoulder_joints.FlexAddShoulderMixin
        • symbrim.rider.shoulder_joints.FlexRotLeftShoulder
        • symbrim.rider.shoulder_joints.FlexRotRightShoulder
        • symbrim.rider.shoulder_joints.FlexRotShoulderMixin
        • symbrim.rider.shoulder_joints.SphericalLeftShoulder
        • symbrim.rider.shoulder_joints.SphericalRightShoulder
        • symbrim.rider.shoulder_joints.SphericalShoulderMixin
        • symbrim.rider.shoulder_joints.SphericalShoulderSpringDamper
        • symbrim.rider.shoulder_joints.SphericalShoulderTorque
      • symbrim.rider.torso
        • symbrim.rider.torso.PlanarTorso
        • symbrim.rider.torso.TorsoBase
    • symbrim.core
      • symbrim.core.attachment
        • symbrim.core.attachment.Attachment
        • symbrim.core.attachment.Hub
        • symbrim.core.attachment.MasslessBody
      • symbrim.core.auxiliary
        • symbrim.core.auxiliary.AuxiliaryData
        • symbrim.core.auxiliary.AuxiliaryDataHandler
      • symbrim.core.base_classes
        • symbrim.core.base_classes.set_default_convention
        • symbrim.core.base_classes.BrimBase
        • symbrim.core.base_classes.ConnectionBase
        • symbrim.core.base_classes.ConnectionMeta
        • symbrim.core.base_classes.LoadGroupBase
        • symbrim.core.base_classes.LoadGroupMeta
        • symbrim.core.base_classes.ModelBase
        • symbrim.core.base_classes.ModelMeta
      • symbrim.core.mixins
        • symbrim.core.mixins.NewtonianBodyMixin
      • symbrim.core.registry
        • symbrim.core.registry.Registry
      • symbrim.core.requirement
        • symbrim.core.requirement.ConnectionRequirement
        • symbrim.core.requirement.ModelRequirement
        • symbrim.core.requirement.RequirementBase
      • symbrim.core.singleton
        • symbrim.core.singleton.Singleton
        • symbrim.core.singleton.SingletonMeta
    • symbrim.other
      • symbrim.other.rolling_disc
        • symbrim.other.rolling_disc.rolling_disc_manual
        • symbrim.other.rolling_disc.RollingDisc
    • symbrim.utilities
      • symbrim.utilities.benchmarking
        • symbrim.utilities.benchmarking.benchmark
      • symbrim.utilities.parametrize
        • symbrim.utilities.parametrize.get_inertia_vals
        • symbrim.utilities.parametrize.get_inertia_vals_from_yeadon
      • symbrim.utilities.plotting
        • symbrim.utilities.plotting.PlotBrimMixin
        • symbrim.utilities.plotting.PlotConnection
        • symbrim.utilities.plotting.PlotLoadGroup
        • symbrim.utilities.plotting.PlotModel
        • symbrim.utilities.plotting.Plotter
      • symbrim.utilities.testing
        • symbrim.utilities.testing.create_model_of_connection
        • symbrim.utilities.testing.ignore_point_warnings
      • symbrim.utilities.utilities
        • symbrim.utilities.utilities.check_zero
        • symbrim.utilities.utilities.random_eval
Back to top
View this page

SymBRiM DocumentationΒΆ

SymBRiM: a Modular and Extensible Open-Source Framework for Creating Symbolic Bicycle-Rider Models.

_images/lane_change.gif
  • User Guide
    • Installation
    • Introduction to SymBRiM
    • Guidelines on Implementing Components
  • Tutorials
    • Four-bar Linkage
    • Building Bicycle-Rider Models with SymBRiM
    • Rolling Disc From Scratch
  • Contributing
  • API Reference
    • symbrim.brim
    • symbrim.bicycle
    • symbrim.rider
    • symbrim.core
    • symbrim.other
    • symbrim.utilities
Next
User Guide
Copyright © 2023, Timo Stienstra
Made with Sphinx and @pradyunsg's Furo