https://github.com/moorepants/bicycleparameters
Calculates the geometry, masses, centers of mass, and the moments of inertia of the bicycle rider system.
https://github.com/moorepants/bicycleparameters
bicycle dynamics engineering python
Last synced: about 1 year ago
JSON representation
Calculates the geometry, masses, centers of mass, and the moments of inertia of the bicycle rider system.
- Host: GitHub
- URL: https://github.com/moorepants/bicycleparameters
- Owner: moorepants
- License: other
- Created: 2011-06-29T21:24:30.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T11:15:06.000Z (over 1 year ago)
- Last Synced: 2024-10-25T12:41:02.616Z (over 1 year ago)
- Topics: bicycle, dynamics, engineering, python
- Language: Python
- Homepage: https://bicycleparameters.readthedocs.io
- Size: 1.1 MB
- Stars: 37
- Watchers: 4
- Forks: 20
- Open Issues: 24
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE.txt
- Authors: AUTHORS
Awesome Lists containing this project
README
=================
BicycleParameters
=================
A Python program designed to generate, manipulate, and visualize the parameters
of the Whipple-Carvallo bicycle model.
.. list-table::
* - Download from PyPi
- |PyPi|
* - Download from Anaconda
- |Anaconda|
* - Documentation
- |RTD|
* - CI Status
- |GHCI|
* - Render App
- |Render|
.. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg
:target: https://pypi.org/project/BicycleParameters/
.. |Anaconda| image:: https://anaconda.org/conda-forge/bicycleparameters/badges/version.svg
:target: https://anaconda.org/conda-forge/bicycleparameters
.. |GHCI| image:: https://github.com/moorepants/BicycleParameters/actions/workflows/test.yml/badge.svg
.. |RTD| image:: https://readthedocs.org/projects/bicycleparameters/badge/?version=latest
:target: https://bicycleparameters.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |Render| image:: https://img.shields.io/badge/Bicycle_Dynamics_App-Render.io-blue
:target: https://bicycle-dynamics.onrender.com
Dependencies
============
Required
--------
- `DynamicistToolKit >= 0.5.3 `_
- `Matplotlib >= 3.5.1 `_
- `NumPy >= 1.21.5 `_
- `Python >= 3.8 `_
- `SciPy >= 1.8.0 `_
- `Uncertainties >= 3.1.5 `_
- `yeadon >= 1.3.0 `_
Optional
--------
These are required to run the Dash web application:
- `Dash >= 2.0 `_
- `dash-bootstrap-components `_
- `Pandas >= 1.3.5 `_
These are required to build the documentation:
- `Sphinx >= 4.3.2 `_
- `Numpydoc >= 1.2 `_
Installation
============
We recommend installing BicycleParameters with conda_ or pip_.
.. _conda: https://docs.conda.io
.. _pip: https://pip.pypa.io
For conda::
$ conda install -c conda-forge bicycleparameters
For pip::
$ pip install BicycleParameters
The package can also be installed from the source code. The options for getting
the source code are:
1. Clone the source code with Git: ``git clone
git://github.com/moorepants/BicycleParameters.git``
2. `Download the source from Github`__.
3. Download the source from pypi__.
.. __: https://github.com/moorepants/BicycleParameters
.. __: http://pypi.python.org/pypi/BicycleParameters
Once you have the source code navigate to the directory and run::
>>> python setup.py install
This will install the software into your system. You can check if it installs
with::
$ python -c "import bicycleparameters"
Example Code
============
.. code-block:: python
>>> import bicycleparameters as bp
>>> import numpy as np
>>> rigid = bp.Bicycle('Rigid')
>>> par = rigid.parameters['Benchmark']
>>> rigid.plot_bicycle_geometry()
>>> speeds = np.linspace(0., 10., num=100)
>>> rigid.plot_eigenvalues_vs_speed(speeds)
Sample Data
===========
Some sample data is included in the repository but a full source with all the
raw data files can be downloaded from here:
http://dx.doi.org/10.6084/m9.figshare.1198429
Documentation
=============
Please refer to the `online documentation
`_ for more information.
Grant Information
=================
This material is partially based upon work supported by the National Science
Foundation under `Grant No. 0928339`_. Any opinions, findings, and conclusions
or recommendations expressed in this material are those of the authors and do
not necessarily reflect the views of the National Science Foundation.
.. _Grant No. 0928339: https://www.nsf.gov/awardsearch/showAward?AWD_ID=0928339
This material is partially based upon work supported by the TKI CLICKNL grant
"Fiets van de Toekomst"(Grant No. TKI1706).