index.m

%% Vehicle Dynamics - Lateral: Open Source Simulation Package for MATLAB
% This repository provides a collection of functions destinated to lateral dynamics simulations of ground vehicles.
%
%% Instructions
% Installation steps:
%
% * Download the Vehicle-Dynamics package by clicking on "Download ZIP" in <https://github.com/andresmendes/Vehicle-Dynamics-Lateral https://github.com/andresmendes/Vehicle-Dynamics-Lateral>.
% * Save the package (folder "+VehicleDynamicsLateral") in the MATLAB(R) _path_ or add your current path to the _paths list_. More details in <http://www.mathworks.com/help/matlab/ref/path.html  help path>.
% * Import the entire package with the command:
%

import VehicleDynamicsLateral.*

%% Getting started
%
% Run and explore the files <TemplateSimple.html TemplateSimple.m> and <TemplateArticulated.html TemplateArticulated.m>.
%
%% Description
%
% <<illustrations/fluxograma.svg>>
%
%% Examples
% The templates simulate vehicle systems according to the flowchart above.
%
% * <TemplateSimple.html Template Simple> - Simple vehicle simulation.
% * <TemplateArticulated.html Template Articulated> - Articulated vehicle simulation.
% * <TireComparison.html Tire Comparison> - Comparison of tire models.
% * <SinusoidalSteering.html Sinusoidal Steering> - Maneuver with sinusoidal steering angle input.
% * <SteeringControl.html Steering Control> - Double lane change maneuver.
% * <KalmanFilter.html Kalman Filter> - Kalman Filter application
%
%% Tire model
%
% * <DocTireLinear.html Tire linear>
% * <DocTirePolynomial.html Tire polynomial>
% * <DocTirePacejka.html Tire Pacejka>
%
%% Vehicle model
%
% * <DocVehicleSimpleLinear.html Vehicle Simple Linear>
% * <DocVehicleSimpleNonlinear.html Vehicle Simple Nonlinear>
% * <DocVehicleArticulatedLinear.html Vehicle Articulated Linear>
% * <DocVehicleArticulatedNonlinear.html Vehicle Articulated Nonlinear>
%
%% Graphics
% <DocGraphics.html Graphics> - Functions for graphics generation.
%
%% API Documentation
% API Documentation is <api/api.html here>. Help and documentation on-the-fly are available through the "doc" and "help" commands, as usual.
%
%% See Also
%
% <https://github.com/andresmendes/Vehicle-Dynamics-Lateral GitHub Page>