BicycleParameters 1.0.0__tar.gz → 1.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. bicycleparameters-1.1.0/AUTHORS +5 -0
  2. bicycleparameters-1.1.0/BicycleParameters.egg-info/PKG-INFO +174 -0
  3. bicycleparameters-1.1.0/BicycleParameters.egg-info/SOURCES.txt +64 -0
  4. bicycleparameters-1.1.0/BicycleParameters.egg-info/entry_points.txt +2 -0
  5. bicycleparameters-1.1.0/BicycleParameters.egg-info/requires.txt +16 -0
  6. bicycleparameters-1.1.0/CHANGELOG.rst +76 -0
  7. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/LICENSE.txt +1 -1
  8. bicycleparameters-1.1.0/MANIFEST.in +7 -0
  9. bicycleparameters-1.1.0/PKG-INFO +174 -0
  10. bicycleparameters-1.1.0/README.rst +135 -0
  11. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/__init__.py +12 -10
  12. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Benchmark/Parameters/BenchmarkBenchmark.txt +26 -0
  13. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Browser/Parameters/BrowserBenchmark.txt +26 -0
  14. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Browserins/Parameters/BrowserinsBenchmark.txt +26 -0
  15. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Crescendo/Parameters/CrescendoBenchmark.txt +26 -0
  16. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Fisher/Parameters/FisherBenchmark.txt +26 -0
  17. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Pista/Parameters/PistaBenchmark.txt +26 -0
  18. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Rigid/Parameters/RigidBenchmark.txt +40 -0
  19. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Silver/Parameters/SilverBenchmark.txt +30 -0
  20. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Yellow/Parameters/YellowBenchmark.txt +26 -0
  21. bicycleparameters-1.1.0/bicycleparameters/app-data/bicycles/Yellowrev/Parameters/YellowrevBenchmark.txt +26 -0
  22. bicycleparameters-1.1.0/bicycleparameters/app.py +421 -0
  23. bicycleparameters-1.1.0/bicycleparameters/assets/app-explanation.md +104 -0
  24. bicycleparameters-1.1.0/bicycleparameters/assets/styles.css +33 -0
  25. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/bicycle.py +98 -42
  26. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/com.py +24 -19
  27. bicycleparameters-1.1.0/bicycleparameters/conversions.py +142 -0
  28. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/geometry.py +32 -23
  29. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/inertia.py +18 -8
  30. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/io.py +36 -31
  31. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/main.py +638 -143
  32. bicycleparameters-1.1.0/bicycleparameters/models.py +923 -0
  33. bicycleparameters-1.1.0/bicycleparameters/parameter_dicts.py +74 -0
  34. bicycleparameters-1.1.0/bicycleparameters/parameter_sets.py +1431 -0
  35. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/period.py +28 -15
  36. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/plot.py +22 -1
  37. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/rider.py +8 -7
  38. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/tables.py +9 -6
  39. bicycleparameters-1.1.0/bicycleparameters/tests/__init__.py +0 -0
  40. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/benchmark-benchmark.yml +35 -0
  41. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/benchmark-browser.yml +28 -0
  42. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/benchmark-extendedoptc.yml +33 -0
  43. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/benchmark-pista.yml +28 -0
  44. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/benchmark-pistarider.yml +32 -0
  45. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/benchmark-pistarideroptimized3ms.yml +30 -0
  46. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/benchmark-realizedopttwo.yml +30 -0
  47. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/principal-browserjason.yml +53 -0
  48. bicycleparameters-1.1.0/bicycleparameters/tests/parameter_sets/principal-extendedoptf.yml +48 -0
  49. bicycleparameters-1.1.0/bicycleparameters/tests/test_bicycle.py +90 -0
  50. bicycleparameters-1.1.0/bicycleparameters/tests/test_models.py +146 -0
  51. bicycleparameters-1.1.0/bicycleparameters/tests/test_parameter_sets.py +101 -0
  52. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/bicycleparameters/version.py +1 -1
  53. bicycleparameters-1.1.0/docs/app.rst +103 -0
  54. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/docs/bicycleparameters.rst +46 -37
  55. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/docs/data.rst +2 -2
  56. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/docs/description.rst +2 -1
  57. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/docs/examples.rst +167 -4
  58. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/docs/index.rst +1 -0
  59. bicycleparameters-1.1.0/docs/installation.rst +69 -0
  60. bicycleparameters-1.1.0/requirements.txt +10 -0
  61. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/setup.py +28 -12
  62. BicycleParameters-1.0.0/BicycleParameters.egg-info/PKG-INFO +0 -172
  63. BicycleParameters-1.0.0/BicycleParameters.egg-info/SOURCES.txt +0 -33
  64. BicycleParameters-1.0.0/BicycleParameters.egg-info/requires.txt +0 -10
  65. BicycleParameters-1.0.0/MANIFEST.in +0 -4
  66. BicycleParameters-1.0.0/PKG-INFO +0 -172
  67. BicycleParameters-1.0.0/README.rst +0 -151
  68. BicycleParameters-1.0.0/TODO.rst +0 -9
  69. BicycleParameters-1.0.0/bicycleparameters/test/__init__.py +0 -1
  70. BicycleParameters-1.0.0/bicycleparameters/test/test_bicycle.py +0 -38
  71. BicycleParameters-1.0.0/docs/bicycleparameters.test.rst +0 -11
  72. BicycleParameters-1.0.0/docs/installation.rst +0 -53
  73. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/BicycleParameters.egg-info/dependency_links.txt +0 -0
  74. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/BicycleParameters.egg-info/top_level.txt +0 -0
  75. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/RELEASE.rst +0 -0
  76. {BicycleParameters-1.0.0/bicycleparameters/test → bicycleparameters-1.1.0/bicycleparameters/tests}/test_bicycleparameters.py +0 -0
  77. {BicycleParameters-1.0.0 → bicycleparameters-1.1.0}/setup.cfg +0 -0
@@ -0,0 +1,5 @@
1
+ Jason K. Moore <moorepants@gmail.com>
2
+ Chris Dembia
3
+ Oliver Lee
4
+ Lyla Sanders
5
+ Julie van Vlerken
@@ -0,0 +1,174 @@
1
+ Metadata-Version: 2.1
2
+ Name: BicycleParameters
3
+ Version: 1.1.0
4
+ Summary: Generates and manipulates the physical parameters of a bicycle.
5
+ Home-page: http://pypi.python.org/pypi/BicycleParameters
6
+ Author: Jason Keith Moore
7
+ Author-email: moorepants@gmail.com
8
+ License: LICENSE.txt
9
+ Classifier: Programming Language :: Python
10
+ Classifier: Programming Language :: Python :: 3.8
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Development Status :: 5 - Production/Stable
17
+ Classifier: Intended Audience :: Science/Research
18
+ Classifier: License :: OSI Approved :: BSD License
19
+ Classifier: Natural Language :: English
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Scientific/Engineering :: Physics
22
+ Requires-Python: >=3.8
23
+ License-File: LICENSE.txt
24
+ License-File: AUTHORS
25
+ Requires-Dist: DynamicistToolKit>=0.5.3
26
+ Requires-Dist: matplotlib>=3.5.1
27
+ Requires-Dist: numpy>=1.21.5
28
+ Requires-Dist: pyyaml>=5.4.1
29
+ Requires-Dist: scipy>=1.8.0
30
+ Requires-Dist: uncertainties>=3.1.5
31
+ Requires-Dist: yeadon>=1.3.0
32
+ Provides-Extra: doc
33
+ Requires-Dist: sphinx>=4.3.2; extra == "doc"
34
+ Requires-Dist: numpydoc>=1.2; extra == "doc"
35
+ Provides-Extra: app
36
+ Requires-Dist: dash>=2; extra == "app"
37
+ Requires-Dist: dash-bootstrap-components; extra == "app"
38
+ Requires-Dist: pandas>=1.3.5; extra == "app"
39
+
40
+ =================
41
+ BicycleParameters
42
+ =================
43
+
44
+ A Python program designed to generate, manipulate, and visualize the parameters
45
+ of the Whipple-Carvallo bicycle model.
46
+
47
+ .. list-table::
48
+
49
+ * - Download from PyPi
50
+ - |PyPi|
51
+ * - Download from Anaconda
52
+ - |Anaconda|
53
+ * - Documentation
54
+ - |RTD|
55
+ * - CI Status
56
+ - |GHCI|
57
+ * - Render App
58
+ - `Bicycle Dynamics App <https://bicycle-dynamics.onrender.com>`_
59
+
60
+ .. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg
61
+ :target: https://pypi.org/project/BicycleParameters/
62
+
63
+ .. |Anaconda| image:: https://anaconda.org/conda-forge/bicycleparameters/badges/version.svg
64
+ :target: https://anaconda.org/conda-forge/bicycleparameters
65
+
66
+ .. |GHCI| image:: https://github.com/moorepants/BicycleParameters/actions/workflows/test.yml/badge.svg
67
+
68
+ .. |RTD| image:: https://readthedocs.org/projects/bicycleparameters/badge/?version=latest
69
+ :target: https://bicycleparameters.readthedocs.io/en/latest/?badge=latest
70
+ :alt: Documentation Status
71
+
72
+ Dependencies
73
+ ============
74
+
75
+ Required
76
+ --------
77
+
78
+ - `DynamicistToolKit >= 0.5.3 <http://pypi.python.org/pypi/DynamicistToolKit>`_
79
+ - `Matplotlib >= 3.5.1 <https://matplotlib.org/>`_
80
+ - `NumPy >= 1.21.5 <https://numpy.org/>`_
81
+ - `Python >= 3.8 <http://www.python.org/>`_
82
+ - `SciPy >= 1.8.0 <https://scipy.org/>`_
83
+ - `Uncertainties >= 3.1.5 <https://pythonhosted.org/uncertainties/>`_
84
+ - `yeadon >= 1.3.0 <http://pypi.python.org/pypi/yeadon/>`_
85
+
86
+ Optional
87
+ --------
88
+
89
+ These are required to run the Dash web application:
90
+
91
+ - `Dash >= 2.0 <https://plotly.com/dash/>`_
92
+ - `dash-bootstrap-components <https://github.com/facultyai/dash-bootstrap-components>`_
93
+ - `Pandas >= 1.3.5 <https://pandas.pydata.org/>`_
94
+
95
+ These are required to build the documentation:
96
+
97
+ - `Sphinx >= 4.3.2 <http://sphinx.pocoo.org/>`_
98
+ - `Numpydoc >= 1.2 <http://pypi.python.org/pypi/numpydoc>`_
99
+
100
+ Installation
101
+ ============
102
+
103
+ We recommend installing BicycleParameters with conda_ or pip_.
104
+
105
+ .. _conda: https://docs.conda.io
106
+ .. _pip: https://pip.pypa.io
107
+
108
+ For conda::
109
+
110
+ $ conda install -c conda-forge bicycleparameters
111
+
112
+ For pip::
113
+
114
+ $ pip install BicycleParameters
115
+
116
+ The package can also be installed from the source code. The options for getting
117
+ the source code are:
118
+
119
+ 1. Clone the source code with Git: ``git clone
120
+ git://github.com/moorepants/BicycleParameters.git``
121
+ 2. `Download the source from Github`__.
122
+ 3. Download the source from pypi__.
123
+
124
+ .. __: https://github.com/moorepants/BicycleParameters
125
+ .. __: http://pypi.python.org/pypi/BicycleParameters
126
+
127
+ Once you have the source code navigate to the directory and run::
128
+
129
+ >>> python setup.py install
130
+
131
+ This will install the software into your system. You can check if it installs
132
+ with::
133
+
134
+ $ python -c "import bicycleparameters"
135
+
136
+ Example Code
137
+ ============
138
+
139
+ .. code-block:: python
140
+
141
+ >>> import bicycleparameters as bp
142
+ >>> import numpy as np
143
+ >>> rigid = bp.Bicycle('Rigid')
144
+ >>> par = rigid.parameters['Benchmark']
145
+ >>> rigid.plot_bicycle_geometry()
146
+ >>> speeds = np.linspace(0., 10., num=100)
147
+ >>> rigid.plot_eigenvalues_vs_speed(speeds)
148
+
149
+ Sample Data
150
+ ===========
151
+
152
+ Some sample data is included in the repository but a full source with all the
153
+ raw data files can be downloaded from here:
154
+
155
+ http://dx.doi.org/10.6084/m9.figshare.1198429
156
+
157
+ Documentation
158
+ =============
159
+
160
+ Please refer to the `online documentation
161
+ <https://bicycleparameters.readthedocs.io/>`_ for more information.
162
+
163
+ Grant Information
164
+ =================
165
+
166
+ This material is partially based upon work supported by the National Science
167
+ Foundation under `Grant No. 0928339`_. Any opinions, findings, and conclusions
168
+ or recommendations expressed in this material are those of the authors and do
169
+ not necessarily reflect the views of the National Science Foundation.
170
+
171
+ .. _Grant No. 0928339: https://www.nsf.gov/awardsearch/showAward?AWD_ID=0928339
172
+
173
+ This material is partially based upon work supported by the TKI CLICKNL grant
174
+ "Fiets van de Toekomst"(Grant No. TKI1706).
@@ -0,0 +1,64 @@
1
+ AUTHORS
2
+ CHANGELOG.rst
3
+ LICENSE.txt
4
+ MANIFEST.in
5
+ README.rst
6
+ RELEASE.rst
7
+ requirements.txt
8
+ setup.py
9
+ BicycleParameters.egg-info/PKG-INFO
10
+ BicycleParameters.egg-info/SOURCES.txt
11
+ BicycleParameters.egg-info/dependency_links.txt
12
+ BicycleParameters.egg-info/entry_points.txt
13
+ BicycleParameters.egg-info/requires.txt
14
+ BicycleParameters.egg-info/top_level.txt
15
+ bicycleparameters/__init__.py
16
+ bicycleparameters/app.py
17
+ bicycleparameters/bicycle.py
18
+ bicycleparameters/com.py
19
+ bicycleparameters/conversions.py
20
+ bicycleparameters/geometry.py
21
+ bicycleparameters/inertia.py
22
+ bicycleparameters/io.py
23
+ bicycleparameters/main.py
24
+ bicycleparameters/models.py
25
+ bicycleparameters/parameter_dicts.py
26
+ bicycleparameters/parameter_sets.py
27
+ bicycleparameters/period.py
28
+ bicycleparameters/plot.py
29
+ bicycleparameters/rider.py
30
+ bicycleparameters/tables.py
31
+ bicycleparameters/version.py
32
+ bicycleparameters/app-data/bicycles/Benchmark/Parameters/BenchmarkBenchmark.txt
33
+ bicycleparameters/app-data/bicycles/Browser/Parameters/BrowserBenchmark.txt
34
+ bicycleparameters/app-data/bicycles/Browserins/Parameters/BrowserinsBenchmark.txt
35
+ bicycleparameters/app-data/bicycles/Crescendo/Parameters/CrescendoBenchmark.txt
36
+ bicycleparameters/app-data/bicycles/Fisher/Parameters/FisherBenchmark.txt
37
+ bicycleparameters/app-data/bicycles/Pista/Parameters/PistaBenchmark.txt
38
+ bicycleparameters/app-data/bicycles/Rigid/Parameters/RigidBenchmark.txt
39
+ bicycleparameters/app-data/bicycles/Silver/Parameters/SilverBenchmark.txt
40
+ bicycleparameters/app-data/bicycles/Yellow/Parameters/YellowBenchmark.txt
41
+ bicycleparameters/app-data/bicycles/Yellowrev/Parameters/YellowrevBenchmark.txt
42
+ bicycleparameters/assets/app-explanation.md
43
+ bicycleparameters/assets/styles.css
44
+ bicycleparameters/tests/__init__.py
45
+ bicycleparameters/tests/test_bicycle.py
46
+ bicycleparameters/tests/test_bicycleparameters.py
47
+ bicycleparameters/tests/test_models.py
48
+ bicycleparameters/tests/test_parameter_sets.py
49
+ bicycleparameters/tests/parameter_sets/benchmark-benchmark.yml
50
+ bicycleparameters/tests/parameter_sets/benchmark-browser.yml
51
+ bicycleparameters/tests/parameter_sets/benchmark-extendedoptc.yml
52
+ bicycleparameters/tests/parameter_sets/benchmark-pista.yml
53
+ bicycleparameters/tests/parameter_sets/benchmark-pistarider.yml
54
+ bicycleparameters/tests/parameter_sets/benchmark-pistarideroptimized3ms.yml
55
+ bicycleparameters/tests/parameter_sets/benchmark-realizedopttwo.yml
56
+ bicycleparameters/tests/parameter_sets/principal-browserjason.yml
57
+ bicycleparameters/tests/parameter_sets/principal-extendedoptf.yml
58
+ docs/app.rst
59
+ docs/bicycleparameters.rst
60
+ docs/data.rst
61
+ docs/description.rst
62
+ docs/examples.rst
63
+ docs/index.rst
64
+ docs/installation.rst
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ bicycleparameters = bicycleparameters.app:app.run_server
@@ -0,0 +1,16 @@
1
+ DynamicistToolKit>=0.5.3
2
+ matplotlib>=3.5.1
3
+ numpy>=1.21.5
4
+ pyyaml>=5.4.1
5
+ scipy>=1.8.0
6
+ uncertainties>=3.1.5
7
+ yeadon>=1.3.0
8
+
9
+ [app]
10
+ dash>=2
11
+ dash-bootstrap-components
12
+ pandas>=1.3.5
13
+
14
+ [doc]
15
+ sphinx>=4.3.2
16
+ numpydoc>=1.2
@@ -0,0 +1,76 @@
1
+ Release Notes
2
+ =============
3
+
4
+ 1.1.0
5
+ -----
6
+
7
+ - Introduced a Dash based web application for interactive use.
8
+
9
+ - https://github.com/moorepants/BicycleParameters/pull/34
10
+ - https://github.com/moorepants/BicycleParameters/pull/88
11
+
12
+ - Dropped support for Python 2.7, 3.4, 3.5, 3.6, and 3.7. Added support for
13
+ Python 3.8, 3.9, 3.10, 3.11, 3.12.
14
+ - Bumped dependency minimum verions to match Ubuntu 22.04.
15
+ - Moved to mamba and Github action based continuous integration testing.
16
+ - Introduced new parameter_sets and models modules for future class hierarchies
17
+ and better design.
18
+ - ``bicycleparameters/test/`` moved to ``bicycleparameters/tests/``.
19
+ - Removed remaining NumPy ``matrix()`` calls.
20
+ - Improved some of the matplotlib plots.
21
+
22
+ 1.0.0
23
+ -----
24
+
25
+ - Support Python 3
26
+
27
+ 0.2.0
28
+ -----
29
+
30
+ - Commands using the state space form of the Whipple model have been reordered
31
+ to [roll angle, steer angle, roll rate, steer rate]
32
+ - Added another rider's measurments.
33
+ - Added a module for printing tables of data.
34
+ - Added the Gyrobike and the ability to manage it's flywheel rigidbody.
35
+ - Fixed a bug in `calculate_abc_geometry()` that gave incorrect geometry
36
+ values.
37
+ - Handles two additional points for the Davis Instrumented Bicycle.
38
+ - Added a child sized person based on scaling Charlie's measurements.
39
+ - Added Bode plot commands.
40
+ - Added nominal output options for several methods.
41
+ - Added a dependency to DynamicistToolKit
42
+ - Updated core dependencies to a minimum from the Ubuntu 12.04 release.
43
+ - Tested with DTK 0.1.0 to 0.3.5.
44
+ - Added Travis support.
45
+ - The minimum yeadon version is bumped to 1.1.1 and code updated to reflect the
46
+ new yeadon api.
47
+ - The minimum version of uncertainties is bumped to 2.0.
48
+
49
+ 0.1.3
50
+ -----
51
+
52
+ - Speed increase for the eigenvalue calculations.
53
+ - Added measurements for the human configuration on some bikes.
54
+
55
+ 0.1.2
56
+ -----
57
+
58
+ - Fixed the tex related bug for the pendulum fit plots
59
+ - Fixed some import bugs affecting the split fork/handlebar calcs
60
+
61
+ 0.1.1
62
+ -----
63
+
64
+ - changed the default directory to .
65
+ - added pip install notes
66
+ - fixed urls in setup.py and the readme
67
+ - added version number to the package
68
+ - removed the human machine classifier
69
+ - reduced the size of the images in the docs
70
+ - broke bicycleparameters.py into several modules
71
+ - updated the documentation
72
+
73
+ 0.1.0
74
+ -----
75
+
76
+ - Initial release.
@@ -1,4 +1,4 @@
1
- Copyright (c) 2011-2016, Jason Keith Moore
1
+ Copyright (c) 2011-2024, BicycleParameters Authors
2
2
  All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without
@@ -0,0 +1,7 @@
1
+ include *.rst
2
+ include *.txt
3
+ include bicycleparameters/assets/*
4
+ recursive-include bicycleparameters/app-data/ *.txt
5
+ recursive-include docs *.rst
6
+ recursive-include bicycleparameters/ *.yml
7
+ include AUTHORS
@@ -0,0 +1,174 @@
1
+ Metadata-Version: 2.1
2
+ Name: BicycleParameters
3
+ Version: 1.1.0
4
+ Summary: Generates and manipulates the physical parameters of a bicycle.
5
+ Home-page: http://pypi.python.org/pypi/BicycleParameters
6
+ Author: Jason Keith Moore
7
+ Author-email: moorepants@gmail.com
8
+ License: LICENSE.txt
9
+ Classifier: Programming Language :: Python
10
+ Classifier: Programming Language :: Python :: 3.8
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Development Status :: 5 - Production/Stable
17
+ Classifier: Intended Audience :: Science/Research
18
+ Classifier: License :: OSI Approved :: BSD License
19
+ Classifier: Natural Language :: English
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Scientific/Engineering :: Physics
22
+ Requires-Python: >=3.8
23
+ License-File: LICENSE.txt
24
+ License-File: AUTHORS
25
+ Requires-Dist: DynamicistToolKit>=0.5.3
26
+ Requires-Dist: matplotlib>=3.5.1
27
+ Requires-Dist: numpy>=1.21.5
28
+ Requires-Dist: pyyaml>=5.4.1
29
+ Requires-Dist: scipy>=1.8.0
30
+ Requires-Dist: uncertainties>=3.1.5
31
+ Requires-Dist: yeadon>=1.3.0
32
+ Provides-Extra: doc
33
+ Requires-Dist: sphinx>=4.3.2; extra == "doc"
34
+ Requires-Dist: numpydoc>=1.2; extra == "doc"
35
+ Provides-Extra: app
36
+ Requires-Dist: dash>=2; extra == "app"
37
+ Requires-Dist: dash-bootstrap-components; extra == "app"
38
+ Requires-Dist: pandas>=1.3.5; extra == "app"
39
+
40
+ =================
41
+ BicycleParameters
42
+ =================
43
+
44
+ A Python program designed to generate, manipulate, and visualize the parameters
45
+ of the Whipple-Carvallo bicycle model.
46
+
47
+ .. list-table::
48
+
49
+ * - Download from PyPi
50
+ - |PyPi|
51
+ * - Download from Anaconda
52
+ - |Anaconda|
53
+ * - Documentation
54
+ - |RTD|
55
+ * - CI Status
56
+ - |GHCI|
57
+ * - Render App
58
+ - `Bicycle Dynamics App <https://bicycle-dynamics.onrender.com>`_
59
+
60
+ .. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg
61
+ :target: https://pypi.org/project/BicycleParameters/
62
+
63
+ .. |Anaconda| image:: https://anaconda.org/conda-forge/bicycleparameters/badges/version.svg
64
+ :target: https://anaconda.org/conda-forge/bicycleparameters
65
+
66
+ .. |GHCI| image:: https://github.com/moorepants/BicycleParameters/actions/workflows/test.yml/badge.svg
67
+
68
+ .. |RTD| image:: https://readthedocs.org/projects/bicycleparameters/badge/?version=latest
69
+ :target: https://bicycleparameters.readthedocs.io/en/latest/?badge=latest
70
+ :alt: Documentation Status
71
+
72
+ Dependencies
73
+ ============
74
+
75
+ Required
76
+ --------
77
+
78
+ - `DynamicistToolKit >= 0.5.3 <http://pypi.python.org/pypi/DynamicistToolKit>`_
79
+ - `Matplotlib >= 3.5.1 <https://matplotlib.org/>`_
80
+ - `NumPy >= 1.21.5 <https://numpy.org/>`_
81
+ - `Python >= 3.8 <http://www.python.org/>`_
82
+ - `SciPy >= 1.8.0 <https://scipy.org/>`_
83
+ - `Uncertainties >= 3.1.5 <https://pythonhosted.org/uncertainties/>`_
84
+ - `yeadon >= 1.3.0 <http://pypi.python.org/pypi/yeadon/>`_
85
+
86
+ Optional
87
+ --------
88
+
89
+ These are required to run the Dash web application:
90
+
91
+ - `Dash >= 2.0 <https://plotly.com/dash/>`_
92
+ - `dash-bootstrap-components <https://github.com/facultyai/dash-bootstrap-components>`_
93
+ - `Pandas >= 1.3.5 <https://pandas.pydata.org/>`_
94
+
95
+ These are required to build the documentation:
96
+
97
+ - `Sphinx >= 4.3.2 <http://sphinx.pocoo.org/>`_
98
+ - `Numpydoc >= 1.2 <http://pypi.python.org/pypi/numpydoc>`_
99
+
100
+ Installation
101
+ ============
102
+
103
+ We recommend installing BicycleParameters with conda_ or pip_.
104
+
105
+ .. _conda: https://docs.conda.io
106
+ .. _pip: https://pip.pypa.io
107
+
108
+ For conda::
109
+
110
+ $ conda install -c conda-forge bicycleparameters
111
+
112
+ For pip::
113
+
114
+ $ pip install BicycleParameters
115
+
116
+ The package can also be installed from the source code. The options for getting
117
+ the source code are:
118
+
119
+ 1. Clone the source code with Git: ``git clone
120
+ git://github.com/moorepants/BicycleParameters.git``
121
+ 2. `Download the source from Github`__.
122
+ 3. Download the source from pypi__.
123
+
124
+ .. __: https://github.com/moorepants/BicycleParameters
125
+ .. __: http://pypi.python.org/pypi/BicycleParameters
126
+
127
+ Once you have the source code navigate to the directory and run::
128
+
129
+ >>> python setup.py install
130
+
131
+ This will install the software into your system. You can check if it installs
132
+ with::
133
+
134
+ $ python -c "import bicycleparameters"
135
+
136
+ Example Code
137
+ ============
138
+
139
+ .. code-block:: python
140
+
141
+ >>> import bicycleparameters as bp
142
+ >>> import numpy as np
143
+ >>> rigid = bp.Bicycle('Rigid')
144
+ >>> par = rigid.parameters['Benchmark']
145
+ >>> rigid.plot_bicycle_geometry()
146
+ >>> speeds = np.linspace(0., 10., num=100)
147
+ >>> rigid.plot_eigenvalues_vs_speed(speeds)
148
+
149
+ Sample Data
150
+ ===========
151
+
152
+ Some sample data is included in the repository but a full source with all the
153
+ raw data files can be downloaded from here:
154
+
155
+ http://dx.doi.org/10.6084/m9.figshare.1198429
156
+
157
+ Documentation
158
+ =============
159
+
160
+ Please refer to the `online documentation
161
+ <https://bicycleparameters.readthedocs.io/>`_ for more information.
162
+
163
+ Grant Information
164
+ =================
165
+
166
+ This material is partially based upon work supported by the National Science
167
+ Foundation under `Grant No. 0928339`_. Any opinions, findings, and conclusions
168
+ or recommendations expressed in this material are those of the authors and do
169
+ not necessarily reflect the views of the National Science Foundation.
170
+
171
+ .. _Grant No. 0928339: https://www.nsf.gov/awardsearch/showAward?AWD_ID=0928339
172
+
173
+ This material is partially based upon work supported by the TKI CLICKNL grant
174
+ "Fiets van de Toekomst"(Grant No. TKI1706).
@@ -0,0 +1,135 @@
1
+ =================
2
+ BicycleParameters
3
+ =================
4
+
5
+ A Python program designed to generate, manipulate, and visualize the parameters
6
+ of the Whipple-Carvallo bicycle model.
7
+
8
+ .. list-table::
9
+
10
+ * - Download from PyPi
11
+ - |PyPi|
12
+ * - Download from Anaconda
13
+ - |Anaconda|
14
+ * - Documentation
15
+ - |RTD|
16
+ * - CI Status
17
+ - |GHCI|
18
+ * - Render App
19
+ - `Bicycle Dynamics App <https://bicycle-dynamics.onrender.com>`_
20
+
21
+ .. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg
22
+ :target: https://pypi.org/project/BicycleParameters/
23
+
24
+ .. |Anaconda| image:: https://anaconda.org/conda-forge/bicycleparameters/badges/version.svg
25
+ :target: https://anaconda.org/conda-forge/bicycleparameters
26
+
27
+ .. |GHCI| image:: https://github.com/moorepants/BicycleParameters/actions/workflows/test.yml/badge.svg
28
+
29
+ .. |RTD| image:: https://readthedocs.org/projects/bicycleparameters/badge/?version=latest
30
+ :target: https://bicycleparameters.readthedocs.io/en/latest/?badge=latest
31
+ :alt: Documentation Status
32
+
33
+ Dependencies
34
+ ============
35
+
36
+ Required
37
+ --------
38
+
39
+ - `DynamicistToolKit >= 0.5.3 <http://pypi.python.org/pypi/DynamicistToolKit>`_
40
+ - `Matplotlib >= 3.5.1 <https://matplotlib.org/>`_
41
+ - `NumPy >= 1.21.5 <https://numpy.org/>`_
42
+ - `Python >= 3.8 <http://www.python.org/>`_
43
+ - `SciPy >= 1.8.0 <https://scipy.org/>`_
44
+ - `Uncertainties >= 3.1.5 <https://pythonhosted.org/uncertainties/>`_
45
+ - `yeadon >= 1.3.0 <http://pypi.python.org/pypi/yeadon/>`_
46
+
47
+ Optional
48
+ --------
49
+
50
+ These are required to run the Dash web application:
51
+
52
+ - `Dash >= 2.0 <https://plotly.com/dash/>`_
53
+ - `dash-bootstrap-components <https://github.com/facultyai/dash-bootstrap-components>`_
54
+ - `Pandas >= 1.3.5 <https://pandas.pydata.org/>`_
55
+
56
+ These are required to build the documentation:
57
+
58
+ - `Sphinx >= 4.3.2 <http://sphinx.pocoo.org/>`_
59
+ - `Numpydoc >= 1.2 <http://pypi.python.org/pypi/numpydoc>`_
60
+
61
+ Installation
62
+ ============
63
+
64
+ We recommend installing BicycleParameters with conda_ or pip_.
65
+
66
+ .. _conda: https://docs.conda.io
67
+ .. _pip: https://pip.pypa.io
68
+
69
+ For conda::
70
+
71
+ $ conda install -c conda-forge bicycleparameters
72
+
73
+ For pip::
74
+
75
+ $ pip install BicycleParameters
76
+
77
+ The package can also be installed from the source code. The options for getting
78
+ the source code are:
79
+
80
+ 1. Clone the source code with Git: ``git clone
81
+ git://github.com/moorepants/BicycleParameters.git``
82
+ 2. `Download the source from Github`__.
83
+ 3. Download the source from pypi__.
84
+
85
+ .. __: https://github.com/moorepants/BicycleParameters
86
+ .. __: http://pypi.python.org/pypi/BicycleParameters
87
+
88
+ Once you have the source code navigate to the directory and run::
89
+
90
+ >>> python setup.py install
91
+
92
+ This will install the software into your system. You can check if it installs
93
+ with::
94
+
95
+ $ python -c "import bicycleparameters"
96
+
97
+ Example Code
98
+ ============
99
+
100
+ .. code-block:: python
101
+
102
+ >>> import bicycleparameters as bp
103
+ >>> import numpy as np
104
+ >>> rigid = bp.Bicycle('Rigid')
105
+ >>> par = rigid.parameters['Benchmark']
106
+ >>> rigid.plot_bicycle_geometry()
107
+ >>> speeds = np.linspace(0., 10., num=100)
108
+ >>> rigid.plot_eigenvalues_vs_speed(speeds)
109
+
110
+ Sample Data
111
+ ===========
112
+
113
+ Some sample data is included in the repository but a full source with all the
114
+ raw data files can be downloaded from here:
115
+
116
+ http://dx.doi.org/10.6084/m9.figshare.1198429
117
+
118
+ Documentation
119
+ =============
120
+
121
+ Please refer to the `online documentation
122
+ <https://bicycleparameters.readthedocs.io/>`_ for more information.
123
+
124
+ Grant Information
125
+ =================
126
+
127
+ This material is partially based upon work supported by the National Science
128
+ Foundation under `Grant No. 0928339`_. Any opinions, findings, and conclusions
129
+ or recommendations expressed in this material are those of the authors and do
130
+ not necessarily reflect the views of the National Science Foundation.
131
+
132
+ .. _Grant No. 0928339: https://www.nsf.gov/awardsearch/showAward?AWD_ID=0928339
133
+
134
+ This material is partially based upon work supported by the TKI CLICKNL grant
135
+ "Fiets van de Toekomst"(Grant No. TKI1706).
@@ -6,13 +6,15 @@ from .tables import Table
6
6
  from .version import __version_info__, __version__
7
7
 
8
8
  # the modules that are imported when 'from bicycleparameters import *'
9
- __all__ = ['main',
10
- 'geometry',
11
- 'io',
12
- 'period',
13
- 'rider',
14
- 'bicycle',
15
- 'com',
16
- 'inertia',
17
- 'plot',
18
- 'tables']
9
+ __all__ = [
10
+ 'bicycle',
11
+ 'com',
12
+ 'geometry',
13
+ 'inertia',
14
+ 'io',
15
+ 'main',
16
+ 'period',
17
+ 'plot',
18
+ 'rider',
19
+ 'tables',
20
+ ]