Project Chrono: Install the VEHICLE module

Install the VEHICLE module

This is an optional module that enables template-based ground vehicle modeling and simulation within Chrono.

Read the introduction to modules for a technical background on the modularity of the Chrono project.

# Features

The VEHICLE module allows users to model and simulate vehicles.

For more detail, read the Chrono::Vehicle section of the reference manual.

# Dependencies

- This module has no additional dependenies
- Use the CRGTerrain feature requires the OpenCRG library.

For run-time visualization, it is recommended to enable and install the Chrono::VSG module and/or the Chrono::Irrlicht module.

# Building and installing prerequisistes

Chrono::Vehicle includes the option of specifying a terrain using an OpenCRG specification. Support for this optional capability requires the OpenCRG library.

The simplest way to build and install the OpenCRG library is to use the utility scripts provided with the Chrono distribution. These scripts (buildOpenCRG.bat and buildOpenCRG.sh, for Windows and Linux, respectively) are available in the contrib/build-scripts/opencrg directory of the Chrono repository.

1. Copy the appropriate script and place in an arbitrary temporary directory.
2. Edit the script following the instructions in the top comments within the script.
3. Run the script (.\buildOpenCRG.bat or sh buildOpenCRG.sh, as appropriate) from the location of the script copy. This will create a temporary directory where all source repositories will be cloned and a set of directories where the individual URDF dependencies are built.
4. The install directory will contain the necessary header and library files required to configure Chrono::Vehicle with OpenCRG support.

# Building instructions

1. Repeat the instructions for the full installation, but when you see the CMake window, you must add the following steps:
2. Set the ENABLE_MODULE_VEHICLE as 'on', then press 'Configure' (to refresh the variable list)
3. Press 'Configure' again, then 'Generate', and proceed as usual in the installation instructions.

If enabling OpenCRG support (ENABLE_OPENCRG), you will be prompted to provide the location of a local installation of OpenCRG, including the location of the headers, library, and (Windows only) the location of the OpenCRG DLL.

# How to use it

- Consult the reference manual.
- Look at the API section of this module for documentation about classes and functions.
- Look at the C++ source of demos to learn how to use the functions of this module.