BicycleParameters 1.1.0__tar.gz → 1.2.0__tar.gz

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0/BicycleParameters.egg-info}/PKG-INFO

@@ -1,17 +1,22 @@
 Metadata-Version: 2.1
 Name: BicycleParameters
-Version: 1.1.0
+Version: 1.2.0
 Summary: Generates and manipulates the physical parameters of a bicycle.
 Home-page: http://pypi.python.org/pypi/BicycleParameters
-Author: Jason Keith Moore
+Author: Jason K. Moore
 Author-email: moorepants@gmail.com
 License: LICENSE.txt
+Project-URL: Web Application, https://bicycle-dynamics.onrender.com
+Project-URL: Documentation, http://bicycleparameters.readthedocs.io
+Project-URL: Source Code, https://github.com/moorepants/BicycleParameters
+Project-URL: Issue Tracker, https://github.com/moorepants/BicycleParameters/issues
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
@@ -55,7 +60,7 @@ of the Whipple-Carvallo bicycle model.
    * - CI Status
      - |GHCI|
    * - Render App
-     - `Bicycle Dynamics App <https://bicycle-dynamics.onrender.com>`_
+     - |Render|
 
 .. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg
    :target: https://pypi.org/project/BicycleParameters/
@@ -69,6 +74,9 @@ of the Whipple-Carvallo bicycle model.
    :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
 ============
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/BicycleParameters.egg-info/SOURCES.txt

@@ -44,6 +44,7 @@ bicycleparameters/assets/styles.css
 bicycleparameters/tests/__init__.py
 bicycleparameters/tests/test_bicycle.py
 bicycleparameters/tests/test_bicycleparameters.py
+bicycleparameters/tests/test_io.py
 bicycleparameters/tests/test_models.py
 bicycleparameters/tests/test_parameter_sets.py
 bicycleparameters/tests/parameter_sets/benchmark-benchmark.yml

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/CHANGELOG.rst

@@ -1,6 +1,30 @@
 Release Notes
 =============
 
+1.2.0
+-----
+
+- Support Python 3.13.
+- Revert to ``unumpy.matrix`` in mass center and inertia calculations.
+- Updated the raw data mat file loading to work with current Python versions.
+- Support raw data pendulum measurement files with time as an array as well as
+  a fixed sample rate (as before).
+- Remove the unnecessary ``__new__`` method from ``Bicycle``.
+- Added options to show stable ranges and to hide zero eigenvalues in the
+  ``Model`` eigenvalues parts plot.
+- Skip data truncation on raw pendulum time series that have the explicit time
+  array (this is a hack for the Balanceassistv1 data to have valid handlebar
+  inertia).
+- Modernized some internal plotting code.
+- Added measured and calculated parameter data for the Balanceassistv1 bike we
+  measured in the summer of 2024. This is a Gazelle Grenoble C8 HMB electric
+  bicycle with a custom headtube with a steering motor.
+
+1.1.1
+-----
+
+- Ensure that the app's data files are installed.
+
 1.1.0
 -----
 

{bicycleparameters-1.1.0/BicycleParameters.egg-info → bicycleparameters-1.2.0}/PKG-INFO

@@ -1,17 +1,22 @@
 Metadata-Version: 2.1
 Name: BicycleParameters
-Version: 1.1.0
+Version: 1.2.0
 Summary: Generates and manipulates the physical parameters of a bicycle.
 Home-page: http://pypi.python.org/pypi/BicycleParameters
-Author: Jason Keith Moore
+Author: Jason K. Moore
 Author-email: moorepants@gmail.com
 License: LICENSE.txt
+Project-URL: Web Application, https://bicycle-dynamics.onrender.com
+Project-URL: Documentation, http://bicycleparameters.readthedocs.io
+Project-URL: Source Code, https://github.com/moorepants/BicycleParameters
+Project-URL: Issue Tracker, https://github.com/moorepants/BicycleParameters/issues
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
@@ -55,7 +60,7 @@ of the Whipple-Carvallo bicycle model.
    * - CI Status
      - |GHCI|
    * - Render App
-     - `Bicycle Dynamics App <https://bicycle-dynamics.onrender.com>`_
+     - |Render|
 
 .. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg
    :target: https://pypi.org/project/BicycleParameters/
@@ -69,6 +74,9 @@ of the Whipple-Carvallo bicycle model.
    :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
 ============
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/README.rst

@@ -16,7 +16,7 @@ of the Whipple-Carvallo bicycle model.
    * - CI Status
      - |GHCI|
    * - Render App
-     - `Bicycle Dynamics App <https://bicycle-dynamics.onrender.com>`_
+     - |Render|
 
 .. |PyPi| image:: https://img.shields.io/pypi/v/BicycleParameters.svg
    :target: https://pypi.org/project/BicycleParameters/
@@ -30,6 +30,9 @@ of the Whipple-Carvallo bicycle model.
    :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
 ============
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/RELEASE.rst

@@ -2,11 +2,11 @@ These are the instructions for updating the package.
 
 1. Merge all commits from changes.
 2. Update the version info in the README
-3. Update the version number in bicycleparameters.__init__.py
+3. Update the version number in bicycleparameters/version.py
 4. Update the version number in docs/conf.py.
 5. Make sure the docs build.
 6. Git tag for the new version.
-7. python setup.py regsiter sdist upload
+7. python setup.py register sdist upload
 8. Upload the Documentation files.
 
    - cd docs/_build/html

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/com.py

@@ -91,7 +91,7 @@ def center_of_mass(slopes, intercepts):
     # for each line intersection...
     for j, row in enumerate(comb):
         sl = np.array([slopes[row[0]], slopes[row[1]]])
-        a = unumpy.array(np.vstack((-sl, np.ones((2)))).T)
+        a = unumpy.matrix(np.vstack((-sl, np.ones((2)))).T)
         b = np.array([intercepts[row[0]], intercepts[row[1]]])
         lineX[j] = np.dot(a.I, b)
     com = np.mean(lineX, axis=0)

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/geometry.py

@@ -82,11 +82,11 @@ def calculate_abc_geometry(h, d):
     '''
     # extract the values
     h1, h2, h3, h4, h5 = h
-    d1, d2, d3, d4, d = d
+    d1, d2, d3, d4, d_ = d
     # get the perpendicular distances
     a = h1 + h2 - h3 + .5 * d1 - .5 * d2
     b = h4 - .5 * d3 - h5 + .5 * d4
-    c = umath.sqrt(-(a - b)**2 + (d + .5 * (d2 + d3))**2)
+    c = umath.sqrt(-(a - b)**2 + (d_ + .5 * (d2 + d3))**2)
     return a, b, c
 
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/inertia.py

@@ -114,7 +114,7 @@ def inertia_components(jay, beta):
     '''
     sb = unumpy.sin(beta)
     cb = unumpy.cos(beta)
-    betaMat = unumpy.array(np.vstack((cb**2, -2 * sb * cb, sb**2)).T)
+    betaMat = unumpy.matrix(np.vstack((cb**2, -2 * sb * cb, sb**2)).T)
     eye = np.squeeze(np.asarray(np.dot(betaMat.I, jay)))
     return eye
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/io.py

@@ -79,23 +79,23 @@ def load_pendulum_mat_file(pathToFile):
 
     '''
     pendDat = {}
-    loadmat(pathToFile, mdict=pendDat)
+    loadmat(pathToFile, mdict=pendDat, squeeze_me=True, chars_as_strings=True)
     # clean up the matlab imports
-    del(pendDat['__globals__'], pendDat['__header__'], pendDat['__version__'])
-    for k, v in pendDat.items():
-        try:
-            # change to an ascii string
-            pendDat[k] = v[0].encode('ascii')
-        except:
-            # if an array of a single number
-            if np.shape(v)[0] == 1:
-                pendDat[k] = v[0][0]
-            # else if the notes are empty
-            elif np.shape(v)[0] == 0:
-                pendDat[k] = ''
-            # else it is the data which needs to be a one dimensional array
-            else:
-                pendDat[k] = v.reshape((len(v),))
+    del pendDat['__globals__']
+    del pendDat['__header__']
+    del pendDat['__version__']
+    # If notes is empty it loads like `array([], dtype='<U1')`, so make it an
+    # empty string.
+    if not isinstance(pendDat['notes'], str):
+        if pendDat['notes'].shape == (0,):
+            pendDat['notes'] = ''
+    # If a time array is present, it may be variable sample rate so delete the
+    # sampleRate and duration entries if they are there.
+    if 'time' in pendDat:
+        if 'sampleRate' in pendDat:
+            del pendDat['sampleRate']
+        if 'duration' in pendDat:
+            del pendDat['duration']
     return pendDat
 
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/main.py

@@ -40,29 +40,7 @@ class Bicycle(object):
 
     """
 
-    def __new__(cls, bicycleName, pathToData='.', forceRawCalc=False,
-                forcePeriodCalc=False):
-        '''Returns a NoneType object if there is no directory for the
-        bicycle.'''
-        # is there a data directory for this bicycle? if not, tell the user to
-        # put some data in the folder so we have something to work with!
-        try:
-            pathToBicycle = os.path.join(pathToData, 'bicycles', bicycleName)
-            if os.path.isdir(pathToBicycle):
-                print("We have foundeth a directory named: " +
-                      "{0}.".format(pathToBicycle))
-                return super(Bicycle, cls).__new__(cls)
-            else:
-                raise ValueError
-        except:
-            mes = """Are you nuts?! Make a directory called '{0}' with basic
-data for your bicycle in this directory: '{1}'. Then I can actually create a
-bicycle object. You may either need to change to the correct directory or reset
-the pathToData argument.""".format(bicycleName, pathToData)
-            print(mes)
-            return None
-
-    def __init__(self, bicycleName, pathToData='.', forceRawCalc=False,
+    def __init__(self, bicycleName, pathToData=os.curdir, forceRawCalc=False,
                  forcePeriodCalc=False):
         """
         Creates a bicycle object and sets the parameters based on the available
@@ -73,8 +51,8 @@ the pathToData argument.""".format(bicycleName, pathToData)
         bicycleName : string
             The short name of your bicicleta. It should be one word with the
             first letter capitalized and all other letters lower case. You
-            should have a matching directory under `<pathToData>/bicycles/`.
-            For example: `<pathToData>/bicycles/Shortname`.
+            should have a matching directory under ``<pathToData>/bicycles/``.
+            For example: ``<pathToData>/bicycles/Shortname``.
         pathToData : string
             This is the path to the folder where the bicycle/rider parameters
             and raw data are stored. The default is the current working
@@ -96,6 +74,7 @@ the pathToData argument.""".format(bicycleName, pathToData)
         pathToBicycles = os.path.join(pathToData, 'bicycles')
         # the directory where the files for this bicycle are stored
         self.directory = os.path.join(pathToBicycles, bicycleName)
+        self._check_for_bicycle_directory()
 
         # bicycles are assumed not to have a rider when initially loaded
         self.hasRider = False
@@ -145,7 +124,7 @@ the pathToData argument.""".format(bicycleName, pathToData)
         if conOne or conTwo:
             print("Recalcuting the parameters.")
             par, extras = self.calculate_from_measured(
-                    forcePeriodCalc=forcePeriodCalc)
+                forcePeriodCalc=forcePeriodCalc)
             self.parameters['Benchmark'] = par
             self.extras = extras
             print("The glory of the %s parameters are upon you!"
@@ -160,7 +139,7 @@ the pathToData argument.""".format(bicycleName, pathToData)
                                          'Measured.txt')
             try:
                 self.parameters['Measured'] = \
-                        io.load_parameter_text_file(pathToRawFile)
+                    io.load_parameter_text_file(pathToRawFile)
             except IOError:
                 pass
         else:
@@ -169,6 +148,17 @@ the pathToData argument.""".format(bicycleName, pathToData)
             bicycle/{sn}/RawData/ with pendulum data mat files and the
             {sn}Measured.txt file'''.format(sn=bicycleName))
 
+    def _check_for_bicycle_directory(self):
+        # is there a data directory for this bicycle? if not, tell the user to
+        # put some data in the folder so we have something to work with!
+        msg = ("Are you nuts?! Make a directory called '{0}' with basic data "
+               "for your bicycle in this directory: '{1}'. Then I can "
+               "actually create a bicycle object. You may either need to "
+               "change to the correct directory or reset the pathToData "
+               "argument.")
+        if not os.path.isdir(self.directory):
+            raise ValueError(msg.format(self.bicycleName, self.directory))
+
     def __str__(self):
         if self.hasRider:
             desc = "{0} with {1} on board.".format(self.bicycleName,
@@ -1171,7 +1161,7 @@ the pathToData argument.""".format(bicycleName, pathToData)
 
         Parameters
         ----------
-        speeds : ndarray, shape (n,) or float
+        speeds : array_like, shape (n,) or float
             The speed at which to calculate the eigenvalues.
 
         Returns
@@ -1188,11 +1178,10 @@ the pathToData argument.""".format(bicycleName, pathToData)
         model.
 
         '''
-        # this allows you to enter a float
-        try:
-            speeds.shape
-        except AttributeError:
+        if isinstance(speeds, float):
             speeds = np.array([speeds])
+        else:
+            speeds = np.asarray(speeds)
 
         par = io.remove_uncertainties(self.parameters['Benchmark'])
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/models.py

@@ -20,7 +20,7 @@ class _Model(ABC):
 
 
 class Meijaard2007Model(_Model):
-    """Whipple-Carvallo model presented in [Meijaard2007]_. It is both linear
+    """Carvallo-Whipple model presented in [Meijaard2007]_. It is both linear
     and the minimal model in terms of states and coordinates that fully
     describe the vehicle's dynamics: self-stability and non-minimum phase
     behavior.
@@ -549,6 +549,7 @@ class Meijaard2007Model(_Model):
         return axes
 
     def plot_eigenvalue_parts(self, ax=None, colors=None,
+                              show_stable_regions=True, hide_zeros=False,
                               **parameter_overrides):
         """Returns a matplotlib axis of the real and imaginary parts of the
         eigenvalues plotted against the provided parameter.
@@ -559,6 +560,11 @@ class Meijaard2007Model(_Model):
             Matplotlib axes.
         colors : sequence, len(4)
             Matplotlib colors for the 4 modes.
+        show_stable_regions : boolean, optional
+            If true, a grey shaded background will indicate stable regions.
+        hide_zeros : boolean or float, optional
+            If true, real or imaginary parts that are smaller than 1e-12 will
+            not be plotted. Providing a float will set the tolerance.
         **parameter_overrides : dictionary
             Parameter keys that map to floats or array_like of floats
             shape(n,). All keys that map to array_like must be of the same
@@ -588,7 +594,9 @@ class Meijaard2007Model(_Model):
         if len(evals.shape) > 1:
             evals, evecs = sort_eigenmodes(evals, evecs)
         else:
-            evals, evecs = [evals], [evecs]
+            evals, evecs = np.array([evals]), np.array([evecs])
+
+        tol = hide_zeros if isinstance(hide_zeros, float) else 1e-12
 
         par, array_keys, _ = self._parse_parameter_overrides(
             **parameter_overrides)
@@ -597,15 +605,30 @@ class Meijaard2007Model(_Model):
             colors = ['C0', 'C1', 'C2', 'C3']
         legend = ['Mode 1', 'Mode 2', 'Mode 3', 'Mode 4',
                   'Mode 1', 'Mode 2', 'Mode 3', 'Mode 4']
+
+        if show_stable_regions:
+            ax.fill_between(par[array_keys[0]],
+                            np.min([np.min(evals.real), np.min(evals.imag)]),
+                            np.max([np.max(evals.real), np.max(evals.imag)]),
+                            where=np.all(evals.real < 0.0, axis=1),
+                            color='grey',
+                            alpha=0.25,
+                            transform=ax.get_xaxis_transform())
+
         # imaginary components
         for eval_sequence, color, label in zip(evals.T, colors, legend):
-            ax.plot(par[array_keys[0]], np.abs(np.imag(eval_sequence)),
-                    color=color, label=label, linestyle='--')
+            imag_vals = np.abs(np.imag(eval_sequence))
+            if hide_zeros:
+                imag_vals[np.abs(imag_vals) < tol] = np.nan
+            ax.plot(par[array_keys[0]], imag_vals, color=color, label=label,
+                    linestyle='--')
 
         # plot the real parts of the eigenvalues
         for eval_sequence, color, label in zip(evals.T, colors, legend):
-            ax.plot(par[array_keys[0]], np.real(eval_sequence), color=color,
-                    label=label)
+            real_vals = np.real(eval_sequence)
+            if hide_zeros:
+                real_vals[np.abs(real_vals) < tol] = np.nan
+            ax.plot(par[array_keys[0]], real_vals, color=color, label=label)
 
         # set labels and limits
         ax.set_ylabel('Real and Imaginary Parts of the Eigenvalue [1/s]')

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/period.py

@@ -87,22 +87,9 @@ def calc_periods_for_files(directory, filenames, forkIsSplit):
 
     periods = {}
 
-    def pathParts(path):
-        '''Splits a path into a list of its parts.'''
-        components = []
-        while True:
-            (path, tail) = os.path.split(path)
-            if tail == "":
-                components.reverse()
-                return components
-            components.append(tail)
-
-    pathToRawDataParts = pathParts(directory)
-    pathToRawDataParts.pop()
-    pathToBicycleDir = os.path.join(pathToRawDataParts[0],
-                                    pathToRawDataParts[1],
-                                    pathToRawDataParts[2])
-    pathToPlotDir = os.path.join(pathToBicycleDir, 'Plots', 'PendulumFit')
+    # directory is /path/to/data/bicycles/BikeName/RawData
+    path_to_bicycle_dir = os.sep.join(directory.split(os.sep)[:-1])
+    pathToPlotDir = os.path.join(path_to_bicycle_dir, 'Plots', 'PendulumFit')
 
     # make sure there is a place to save the plots
     if not os.path.exists(pathToPlotDir):
@@ -116,12 +103,17 @@ def calc_periods_for_files(directory, filenames, forkIsSplit):
         # generate a variable name for this period
         periodKey = get_period_key(matData, forkIsSplit)
         # calculate the period
-        sampleRate = get_sample_rate(matData)
         pathToPlotFile = os.path.join(pathToPlotDir,
                                       os.path.splitext(f)[0] + '.png')
-        period = get_period_from_truncated(matData['data'],
-                                           sampleRate,
-                                           pathToPlotFile)
+        if 'time' in matData:
+            period = get_period_from_truncated(matData['data'],
+                                               matData['time'],
+                                               pathToPlotFile)
+        else:
+            sampleRate = get_sample_rate(matData)
+            period = get_period_from_truncated(matData['data'],
+                                               sampleRate,
+                                               pathToPlotFile)
         print("The period is:", period, "\n")
         # either append the the period or if it isn't there yet, then
         # make a new list
@@ -212,16 +204,17 @@ def fit_goodness(ym, yp):
     return rsq, SSE, SST, SSR
 
 
-def get_period(data, sampleRate, pathToPlotFile):
+def get_period(data, sample_rate_or_time, pathToPlotFile):
     '''Returns the period and uncertainty for data resembling a decaying
     oscillation.
 
     Parameters
     ----------
-    data : ndarray, shape(n,)
+    data : array_like, shape(n,)
         A time series that resembles a decaying oscillation.
-    sampleRate : int
-        The frequency that data was sampled at.
+    sample_rate_or_time : int or array_like, shape(n,)
+        Either the frequency in Hertz that data was sampled at or a time array
+        that corresponds to ``data``.
     pathToPlotFile : string
         A path to the file to print the plots.
 
@@ -233,7 +226,12 @@ def get_period(data, sampleRate, pathToPlotFile):
     '''
 
     y = data
-    x = np.linspace(0., (len(y) - 1) / float(sampleRate), num=len(y))
+    if isinstance(sample_rate_or_time, int):
+        sample_rate = sample_rate_or_time
+        x = np.linspace(0.0, (len(y) - 1)/float(sample_rate), num=len(y))
+    else:
+        x = sample_rate_or_time
+        sample_rate = int(1.0/np.mean(np.diff(x)))  # approximate
 
     def fitfunc(p, t):
         '''Decaying oscillation function.'''
@@ -246,7 +244,7 @@ def get_period(data, sampleRate, pathToPlotFile):
     # initial guesses
     # p0 = np.array([1.35, -.5, -.75, 0.01, 3.93]) # guess from delft
     # p0 = np.array([2.5, -.75, -.75, 0.001, 4.3]) # guess from ucd
-    p0 = make_guess(data, sampleRate)  # tries to make a good guess
+    p0 = make_guess(data, sample_rate)  # tries to make a good guess
 
     # create the error function
     errfunc = lambda p, t, y: fitfunc(p, t) - y
@@ -284,9 +282,9 @@ def get_period(data, sampleRate, pathToPlotFile):
     T = 1. / fd
 
     # plot the data and save it to file
-    fig = plt.figure()
+    fig, ax = plt.subplots(layout='constrained')
     plot_osfit(x, y, lscurve, p1, rsq, T, m=np.max(x), fig=fig)
-    plt.savefig(pathToPlotFile)
+    fig.savefig(pathToPlotFile)
     plt.close()
 
     # return the period
@@ -296,7 +294,15 @@ def get_period(data, sampleRate, pathToPlotFile):
 def get_period_from_truncated(data, sampleRate, pathToPlotFile):
     # dataRec = average_rectified_sections(data)
     dataRec = data
-    dataGood = select_good_data(dataRec, 0.1)
+    # Don't truncate if the time array is provided in the measurements. This is
+    # present because truncating causes bad inertia values for the
+    # Balanceassistv1 fork. This is a bit of a hack. It would be better to have
+    # optional data processing steps per trials to maximize good period
+    # estimates. This is trying to be a catch all as designed.
+    if isinstance(sampleRate, np.ndarray):  # time array
+        dataGood = dataRec
+    else:
+        dataGood = select_good_data(dataRec, 0.1)
     return get_period(dataGood, sampleRate, pathToPlotFile)
 
 
@@ -456,7 +462,7 @@ def plot_osfit(t, ym, yf, p, rsq, T, m=None, fig=None):
         The measured voltage
     yf : ndarray (n,)
     p : ndarray (5,)
-        The fit parameters for the decaying osicallation fucntion
+        The fit parameters for the decaying oscillation function.
     rsq : float
         The r squared value of y (the fit)
     T : float
@@ -469,38 +475,20 @@ def plot_osfit(t, ym, yf, p, rsq, T, m=None, fig=None):
     fig : the figure
 
     '''
-    # figure properties
-    figwidth = 4.  # in inches
-    goldenMean = (np.sqrt(5) - 1.0) / 2.0
-    figsize = [figwidth, figwidth * goldenMean]
-    params = {#'backend': 'ps',
-        'axes.labelsize': 8,
-        'axes.titlesize': 8,
-        'text.fontsize': 8,
-        'legend.fontsize': 8,
-        'xtick.labelsize': 6,
-        'ytick.labelsize': 6,
-        'text.usetex': True,
-        #'figure.figsize': figsize
-        }
     if fig:
-        fig = fig
+        ax1 = fig.axes[0]
     else:
-        fig = plt.figure(2)
-    fig.set_size_inches(figsize)
-    plt.rcParams.update(params)
-    ax1 = plt.axes([0.125, 0.125, 0.9-0.125, 0.65])
-    #if m == None:
-        #end = len(t)
-    #else:
-        #end = t[round(m/t[-1]*len(t))]
-    ax1.plot(t, ym, '.', markersize=2)
+        fig, ax1 = plt.subplots(layout='constrained')
+    ax1.plot(t, ym, '.', markersize=4)
     plt.plot(t, yf, 'k-')
     plt.xlabel('Time [s]')
     plt.ylabel('Amplitude [V]')
-    equation = r'$f(t)={0:1.2f}+e^{{-({3:1.3f})({4:1.1f})t}}\left[{1:1.2f}\sin{{\sqrt{{1-{3:1.3f}^2}}{4:1.1f}t}}+{2:1.2f}\cos{{\sqrt{{1-{3:1.3f}^2}}{4:1.1f}t}}\right]$'.format(p[0], p[1], p[2], p[3], p[4])
-    rsquare = '$r^2={0:1.3f}$'.format(rsq)
-    period = '$T={0} s$'.format(T)
+    equation = (r'$f(t)={0:1.2f}+e^{{-({3:1.3f})({4:1.1f})t}}\left[{1:1.2f}'
+                r'\sin{{\sqrt{{1-{3:1.3f}^2}}{4:1.1f}t}}+{2:1.2f}'
+                r'\cos{{\sqrt{{1-{3:1.3f}^2}}{4:1.1f}t}}\right]$')
+    equation = equation.format(p[0], p[1], p[2], p[3], p[4])
+    rsquare = r'$r^2={0:1.3f}$'.format(rsq)
+    period = r'$T={0} s$'.format(T)
     plt.title(equation + '\n' + rsquare + ', ' + period)
     plt.legend(['Measured', 'Fit'])
     if m is not None:
@@ -511,13 +499,12 @@ def plot_osfit(t, ym, yf, p, rsq, T, m=None, fig=None):
 
 
 def select_good_data(data, percent):
-
     '''Returns a slice of the data from the index at maximum value to the index
     at a percent of the maximum value.
 
     Parameters
     ----------
-    data : ndarray, shape(1,)
+    data : ndarray, shape(n,)
         This should be a decaying function.
     percent : float
         The percent of the maximum to clip.

bicycleparameters-1.2.0/bicycleparameters/tests/test_io.py

@@ -0,0 +1,26 @@
+import os
+import numpy as np
+from bicycleparameters.io import load_pendulum_mat_file
+
+TESTS_DIR = os.path.dirname(__file__)
+
+
+def test_load_pendulum_mat_file():
+    path = os.path.join(TESTS_DIR, 'sample_data',
+                        'BrowserForkCompoundFirst1.mat')
+
+    d = load_pendulum_mat_file(path)
+
+    assert d['angle'] == 'First'
+    assert d['ActualRate'] == 1000
+    assert d['bicycle'] == 'BrowserIns'
+    assert d['data'].shape == (30000,)
+    np.testing.assert_allclose(
+        d['data'][0:5],
+        np.array([0.33034183, 0.32525861, 0.31509219, 0.31509219, 0.33034183]))
+    assert d['duration'] == 30
+    assert d['filename'] == 'BrowserInsForkCompoundFirst1'
+    assert d['notes'] == ''
+    assert d['part'] == 'Fork'
+    assert d['pendulum'] == 'Compound'
+    assert d['trial'] == '1'

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/bicycleparameters/version.py

@@ -1,2 +1,2 @@
-__version_info__ = (1, 1, 0)
+__version_info__ = (1, 2, 0)
 __version__ = '.'.join(map(str, __version_info__))

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/docs/data.rst

@@ -211,14 +211,31 @@ Notes
 
 Pendulum Data Files
 ===================
+
 If you have raw signal data that the periods can be estimated from, then these
 should be included in the ``RawData`` directory. There should be at least one
 file for every period typically found in ``<bicycle name>Measured.txt`` file. The
 signals collected should exhibit very typical decayed oscillations. Currently
 the only supported file is a Matlab mat file with these variables:
 
-- ``data`` : signal vector of a decaying oscillation
-- ``sampleRate`` : sample rate of data in hertz
+- ``bicycle``, char : short name of the bicycle, e.g. ``'Browser'``
+- ``part``, char : examples are ``'Fork'``, ``'Frame'``, ``'Rwheel'``
+- ``pendulum``, char : either ``'Compound'`` or ``'Torsional'``
+- ``angle`` or ``angleOrder``, char : the ``'First'``, ``'Second'``, ...,
+  ``'Sixth'`` orientation
+- ``trial``, char : the integer number of the repetition ``'1'``, ``'2'``, etc.
+- ``filename``, char : filename constructed from above variables (see below for
+  explanation)
+- ``notes``, char : any notes recorded for that measurement
+- ``data``, double size n x 1 : signal vector of a decaying oscillation (from
+  rate gyro)
+- Time information, either ``time`` OR both ``duration`` and ``sampleRate``:
+
+   - ``duration``, double size 1 x 1 : time in seconds for the measurement
+   - ``sampleRate`` or ``ActualRate``, double size 1 x 1 (integer) : sample
+     rate of data in Hertz
+   - ``time``, double size n x 1 : time values in seconds that correspond to
+     ``data``
 
 The files should be named in this manner ``<short
 name><part><pendulum><orientation><trial>.mat`` where:
@@ -230,6 +247,11 @@ name><part><pendulum><orientation><trial>.mat`` where:
   ``Fifth``, or ``Sixth``
 - ``<trial>`` is an integer greater than or equal to 1
 
+These data files were originally collected with Matlab and a National
+Instruments USB-6218 using a Silicon Sensing CRS03-04S single axis angular rate
+gyro and a `data collection script
+<https://github.com/moorepants/PhysicalParameters/blob/master/PhysicalParameters/matlab/acquire_data.m>`_.
+
 Notes
 -----
 
@@ -273,7 +295,7 @@ files.
 riders/<rider name>/RawData/
 ============================
 
-**These files must follow the YAML format used in the `yeadon package`_.**
+**These files must follow the YAML format used in the yeadon package.**
 
 <rider name><bicycle name>YeadonCFG.txt
 ---------------------------------------
@@ -291,4 +313,4 @@ all of the geometric measurements of the rider. See the `yeadon documentation`_
 for more details.
 
 .. _yeadon package: http://pypi.python.org/pypi/yeadon
-.. _yeadon documentation : http://packages.python.org/yeadon/
+.. _yeadon documentation : https://yeadon.readthedocs.io

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/docs/examples.rst

@@ -617,6 +617,20 @@ plotted:
 
    model.plot_eigenvalue_parts(v=speeds)
 
+There are several common customization options available:
+
+.. plot::
+   :include-source: True
+   :context: close-figs
+
+   speeds = np.linspace(0.0, 10.0, num=200)
+
+   ax = model.plot_eigenvalue_parts(v=speeds,
+                                    colors=['C0', 'C0', 'C1', 'C2'],
+                                    show_stable_regions=False,
+                                    hide_zeros=True)
+   ax.set_ylim((-10.0, 10.0))
+
 You can choose any parameter in the dictionary to generate the root locus and
 also override other parameters.
 

{bicycleparameters-1.1.0 → bicycleparameters-1.2.0}/setup.py

@@ -7,13 +7,20 @@ exec(open('bicycleparameters/version.py').read())
 setup(
     name='BicycleParameters',
     version=__version__,
-    author='Jason Keith Moore',
+    author='Jason K. Moore',
     author_email='moorepants@gmail.com',
     packages=find_packages(),
     url='http://pypi.python.org/pypi/BicycleParameters',
     license='LICENSE.txt',
     description='Generates and manipulates the physical parameters of a bicycle.',
     long_description=open('README.rst').read(),
+    project_urls={
+        'Web Application': 'https://bicycle-dynamics.onrender.com',
+        'Documentation': 'http://bicycleparameters.readthedocs.io',
+        'Source Code': 'https://github.com/moorepants/BicycleParameters',
+        'Issue Tracker': 'https://github.com/moorepants/BicycleParameters/issues',
+    },
+    include_package_data=True,  # includes things in MANIFEST.in
     install_requires=[
         'DynamicistToolKit>=0.5.3',
         'matplotlib>=3.5.1',
@@ -43,6 +50,7 @@ setup(
                  'Programming Language :: Python :: 3.10',
                  'Programming Language :: Python :: 3.11',
                  'Programming Language :: Python :: 3.12',
+                 'Programming Language :: Python :: 3.13',
                  'Operating System :: OS Independent',
                  'Development Status :: 5 - Production/Stable',
                  'Intended Audience :: Science/Research',