Metadata-Version: 1.0
Name: BicycleParameters
Version: 0.1.0
Summary: Generates and manipulates the physical parameters of a bicycle.
Home-page: http://pypi.python.org/pypi/bicycleparameters
Author: Jason Keith Moore
Author-email: moorepants@gmail.com
License: LICENSE.txt
Description: =========================
        Bicycle Parameters Module
        =========================
        
        A python program designed to produce and manipulate the basic parameters needed for
        the Whipple bicycle model.
        
        Dependencies
        ============
        These are the versions that I tested the code with, but the code will most
        likely work with older versions.
        
        Required
        --------
        - `Python 2.7.1 <http://www.python.org/>`_
        - `Scipy 0.9.0 <http://www.scipy.org/>`_
        - `Numpy 1.5.1 <http://numpy.scipy.org/>`_
        - `Matplotlib 0.99.3 <http://matplotlib.sourceforge.net/>`_
        - `Uncertainties 1.7.3 <http://packages.python.org/uncertainties/>`_
        - `yeadon 0.8 <https://github.com/fitze/yeadon>`_
        
        Optional
        --------
        These are required to bulid the documentation:
        
        - `Sphinx <http://sphinx.pocoo.org/>`_
        - `Numpydoc <http://pypi.python.org/pypi/numpydoc>`_
        
        Installation
        ============
        There are currently two options for getting the source code:
        
        1. Clone the source code with Git: ``git clone
           git://github.com/moorepants/BicycleParameters.git``
        2. `Download the source from Github`__.
        
        .. __: https://github.com/moorepants/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 and you should be able to
        import it with::
        
          >>>import bicycleparameters
        
        Example Code
        ============
        
        ::
        
            >>>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)
        
        Documentation
        =============
        Please refer to the `online documentation
        <http://packages.python.org/bicycleparameters>`_ for more information.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Physics
