Coder Social home page Coder Social logo

obd's Introduction

OBD:  Open Bicycle Dynamics
===========================

A C++ library for studying the bicycle.  Includes programs for:
    - numerical simulation of nonlinear equations of motion
    - eigenvalues of linearized upright zero-steer dynamics as function of speed
    - generation of numerous level curve plots in the lean-steer plane
    - Python code to plot all results and save the data

License: GNU GPLv3  (see COPYING file for details)

0. Download
-----------
The current release is available here:

http://www.dlpeterson.com/OBD/

The development source code is hosted on github.com.  To build from the
development source, you will need cmake installed.  Out of source builds are
the only supported approach to building.  Here is how to clone the source code
and build it:

    $ git clone git://github.com/hazelnusse/OBD.git
    $ mkdir OBD-build
    $ cd OBD-build
    $ cmake ../OBD
    $ make

cmake also supports a graphical configuration, use cmake-gui instead of cmake.
This allows you to see the various build options that exist.

1. Required libraries
---------------------
To build the source, you must be able to link to the following libaries:

GSL    -- GNU Scientific Library, provides ODE and root finding support
Qt     -- Nokia's GUI framework
Eigen  -- C++ linear algebra library

2. Getting help
---------------
Each of the executables generated by make support several command line options.
To see what options are supported, do:

    $ ./whippleeig --help

Currently, looking at the source is the form of best documentation, Doxygen
should be coming soon.

3. Running tests
----------------
After running cmake (or cmake-gui), type:

    $ make test

4. Building Documentation
-------------------------
If you have Doxygen installed, you can build html and LaTeX documentation by
typing:

    $ make doc

The resulting documentation will be in the doc/ folder

obd's People

Contributors

hazelnusse avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.