=================
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 <http://pypi.python.org/pypi/DynamicistToolKit>`_
- `Matplotlib >= 3.5.1 <https://matplotlib.org/>`_
- `NumPy >= 1.21.5 <https://numpy.org/>`_
- `Python >= 3.8 <http://www.python.org/>`_
- `SciPy >= 1.8.0 <https://scipy.org/>`_
- `Uncertainties >= 3.1.5 <https://pythonhosted.org/uncertainties/>`_
- `yeadon >= 1.3.0 <http://pypi.python.org/pypi/yeadon/>`_
Optional
--------
These are required to run the Dash web application:
- `Dash >= 2.0 <https://plotly.com/dash/>`_
- `dash-bootstrap-components <https://github.com/facultyai/dash-bootstrap-components>`_
- `Pandas >= 1.3.5 <https://pandas.pydata.org/>`_
These are required to build the documentation:
- `Sphinx >= 4.3.2 <http://sphinx.pocoo.org/>`_
- `Numpydoc >= 1.2 <http://pypi.python.org/pypi/numpydoc>`_
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
<https://bicycleparameters.readthedocs.io/>`_ 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).
Raw data
{
"_id": null,
"home_page": "http://pypi.python.org/pypi/BicycleParameters",
"name": "BicycleParameters",
"maintainer": null,
"docs_url": "https://pythonhosted.org/BicycleParameters/",
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jason K. Moore",
"author_email": "moorepants@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/23/82/d777ff2481d4155de78a69d95b2d29f3177d3b1830fef76a7a7fcb58dd8e/bicycleparameters-1.2.0.tar.gz",
"platform": null,
"description": "=================\nBicycleParameters\n=================\n\nA Python program designed to generate, manipulate, and visualize the parameters\nof the Whipple-Carvallo bicycle model.\n\n.. list-table::\n\n * - Download from PyPi\n - |PyPi|\n * - Download from Anaconda\n - |Anaconda|\n * - Documentation\n - |RTD|\n * - CI Status\n - |GHCI|\n * - Render App\n - |Render|\n\n.. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg\n :target: https://pypi.org/project/BicycleParameters/\n\n.. |Anaconda| image:: https://anaconda.org/conda-forge/bicycleparameters/badges/version.svg\n :target: https://anaconda.org/conda-forge/bicycleparameters\n\n.. |GHCI| image:: https://github.com/moorepants/BicycleParameters/actions/workflows/test.yml/badge.svg\n\n.. |RTD| image:: https://readthedocs.org/projects/bicycleparameters/badge/?version=latest\n :target: https://bicycleparameters.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |Render| image:: https://img.shields.io/badge/Bicycle_Dynamics_App-Render.io-blue\n :target: https://bicycle-dynamics.onrender.com\n\nDependencies\n============\n\nRequired\n--------\n\n- `DynamicistToolKit >= 0.5.3 <http://pypi.python.org/pypi/DynamicistToolKit>`_\n- `Matplotlib >= 3.5.1 <https://matplotlib.org/>`_\n- `NumPy >= 1.21.5 <https://numpy.org/>`_\n- `Python >= 3.8 <http://www.python.org/>`_\n- `SciPy >= 1.8.0 <https://scipy.org/>`_\n- `Uncertainties >= 3.1.5 <https://pythonhosted.org/uncertainties/>`_\n- `yeadon >= 1.3.0 <http://pypi.python.org/pypi/yeadon/>`_\n\nOptional\n--------\n\nThese are required to run the Dash web application:\n\n- `Dash >= 2.0 <https://plotly.com/dash/>`_\n- `dash-bootstrap-components <https://github.com/facultyai/dash-bootstrap-components>`_\n- `Pandas >= 1.3.5 <https://pandas.pydata.org/>`_\n\nThese are required to build the documentation:\n\n- `Sphinx >= 4.3.2 <http://sphinx.pocoo.org/>`_\n- `Numpydoc >= 1.2 <http://pypi.python.org/pypi/numpydoc>`_\n\nInstallation\n============\n\nWe recommend installing BicycleParameters with conda_ or pip_.\n\n.. _conda: https://docs.conda.io\n.. _pip: https://pip.pypa.io\n\nFor conda::\n\n $ conda install -c conda-forge bicycleparameters\n\nFor pip::\n\n $ pip install BicycleParameters\n\nThe package can also be installed from the source code. The options for getting\nthe source code are:\n\n1. Clone the source code with Git: ``git clone\n git://github.com/moorepants/BicycleParameters.git``\n2. `Download the source from Github`__.\n3. Download the source from pypi__.\n\n.. __: https://github.com/moorepants/BicycleParameters\n.. __: http://pypi.python.org/pypi/BicycleParameters\n\nOnce you have the source code navigate to the directory and run::\n\n >>> python setup.py install\n\nThis will install the software into your system. You can check if it installs\nwith::\n\n $ python -c \"import bicycleparameters\"\n\nExample Code\n============\n\n.. code-block:: python\n\n >>> import bicycleparameters as bp\n >>> import numpy as np\n >>> rigid = bp.Bicycle('Rigid')\n >>> par = rigid.parameters['Benchmark']\n >>> rigid.plot_bicycle_geometry()\n >>> speeds = np.linspace(0., 10., num=100)\n >>> rigid.plot_eigenvalues_vs_speed(speeds)\n\nSample Data\n===========\n\nSome sample data is included in the repository but a full source with all the\nraw data files can be downloaded from here:\n\nhttp://dx.doi.org/10.6084/m9.figshare.1198429\n\nDocumentation\n=============\n\nPlease refer to the `online documentation\n<https://bicycleparameters.readthedocs.io/>`_ for more information.\n\nGrant Information\n=================\n\nThis material is partially based upon work supported by the National Science\nFoundation under `Grant No. 0928339`_. Any opinions, findings, and conclusions\nor recommendations expressed in this material are those of the authors and do\nnot necessarily reflect the views of the National Science Foundation.\n\n.. _Grant No. 0928339: https://www.nsf.gov/awardsearch/showAward?AWD_ID=0928339\n\nThis material is partially based upon work supported by the TKI CLICKNL grant\n\"Fiets van de Toekomst\"(Grant No. TKI1706).\n",
"bugtrack_url": null,
"license": "LICENSE.txt",
"summary": "Generates and manipulates the physical parameters of a bicycle.",
"version": "1.2.0",
"project_urls": {
"Documentation": "http://bicycleparameters.readthedocs.io",
"Homepage": "http://pypi.python.org/pypi/BicycleParameters",
"Issue Tracker": "https://github.com/moorepants/BicycleParameters/issues",
"Source Code": "https://github.com/moorepants/BicycleParameters",
"Web Application": "https://bicycle-dynamics.onrender.com"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2382d777ff2481d4155de78a69d95b2d29f3177d3b1830fef76a7a7fcb58dd8e",
"md5": "c2d3c331ae22d28ec9bd25de28e907ab",
"sha256": "41f6d2aed4d35dccacb5adc33c590367dd9ece7a9e52a4ce0bc3b4ac33080461"
},
"downloads": -1,
"filename": "bicycleparameters-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c2d3c331ae22d28ec9bd25de28e907ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 93987,
"upload_time": "2024-10-11T10:11:45",
"upload_time_iso_8601": "2024-10-11T10:11:45.478710Z",
"url": "https://files.pythonhosted.org/packages/23/82/d777ff2481d4155de78a69d95b2d29f3177d3b1830fef76a7a7fcb58dd8e/bicycleparameters-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 10:11:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "moorepants",
"github_project": "BicycleParameters",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bicycleparameters"
}
JSON
