Skip to main content

SymBRiM

A Modular and Extensible Open-Source Framework for Creating Symbolic Bicycle-Rider Models.

As of October 2024, BRiM has been renamed to SymBRiM.

Links with more information:

This package is still under development, therefore there is no guarantee on backward compatibility.

Installation

SymBRiM is currently not available on PyPI. Therefore, you'll need to install the development version from GitHub using:

pip install git+https://github.com/mechmotum/symbrim.git

The optional dependencies can be installed with:

pip install git+https://github.com/moorepants/BicycleParameters.git
pip install symmeplot

Contributing

Contributions are welcome! Please refer to the contributing page for more information.

Citing

If you use SymBRiM in your research, please cite the following paper:

@inproceedings{stienstra_2023_brim,
    title = {BRiM: A Modular Bicycle-Rider Modeling Framework},
    abstract = {The development of computationally efficient and validated single-track vehicle-rider models has traditionally required handcrafted one-off models. Here we introduce BRiM, a software package that facilitates building these models in a modular fashion while retaining access to the mathematical elements for handcrafted modeling when desired. We demonstrate the flexibility of the software by constructing the Carvallo-Whipple bicycle model with different numerical parameters representing different bicycles, modifying it with a front fork suspension travel model, and extending it with moving rider arms driven by joint torques at the elbows. Using these models we solve a lane-change optimal control problem for six different model variations which solve in mere seconds on a modern personal computer. Our tool enables flexible and rapid modeling of single-track vehicle-rider models that give precise results at high computational efficiency.},
    keywords = {Bicycle Dynamics, BRiM, Computational Modeling, Open-source, SymPy, Simulation, Trajectory Tracking Problem},
    author = {Timótheüs J. Stienstra and Samuel G. Brockie and Jason K. Moore},
    booktitle = {The Evolving Scholar - BMD 2023, 5th Edition},
    year = {2023},
    language = {en},
    doi = "10.59490/6504c5a765e8118fc7b106c3",
}

Metadata

Release files for symbrim 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for symbrim 0.1.0
File Size Uploaded
symbrim-0.1.0.tar.gz 51.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for symbrim 0.1.0
File Interpreter ABI Platform
symbrim-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 124.8 kB

Release files / symbrim-0.1.0.tar.gz

Download URL symbrim-0.1.0.tar.gz
Size 51.9 kB
Tags Source
SHA-256 checksum
How to use checksums
5aff45fd399cbdfe50bd6e731ac7529aef6ff73af2e9b091596fd6effaaec2f6
BLAKE2b-256 checksum
How to use checksums
869c51b55f8988ce2252c9c4de7ed7be404be89f31590addb2ffa49016b7315e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.9.19 Windows/10

Release files / symbrim-0.1.0-py3-none-any.whl

Download URL symbrim-0.1.0-py3-none-any.whl
Size 72.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a3bd80061da7cb60ad273926cd8752f6c9370125e7c6e06d57308885a990af68
BLAKE2b-256 checksum
How to use checksums
3a274cea24ce4d4a51a3dc6a2c8807707e348d33d6462918ed34dd78df715b03
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.9.19 Windows/10

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page