JSBSim Reference Manual

This site is the home of the JSBSim Reference Manual, a website hosted by GitHub Pages, based on MkDocs with the Material for MkDocs theme.

JSBSim is a multi-platform, general purpose object-oriented Flight Dynamics Model (FDM) written in C++. The FDM is essentially the physics & math model that defines the movement of an aircraft, rocket, etc., under the forces and moments applied to it using the various control mechanisms and from the forces of nature. JSBSim can be run in a standalone batch mode flight simulator (no graphical displays) for testing and study, or integrated with FlightGear or other flight simulator.

Contribute

Report bugs or request features.

If you want to report bugs or request features/new additions, please open a new issue.

Contribute to the documentation

If you want to contribute to the documentation, please submit a pull request

For that, you will need to fork this repository and install Python3 and pip on your computer.

1. Install the prerequisites mentioned above.

2. Clone the repository.

git clone https://github.com/JSBSim-Team/jsbsim-reference-manual.git

3. Create an isolated virtual environment.

cd jsbsim-reference-manual
python3 -m venv env # OR < py -m venv env > on Windows

4. Activate the virtual environment and install required PyPi packages.

source env/bin/activate # OR < .\env\Scripts\activate > on Windows
python3 -m pip install -r requirements.txt # OR < py -m pip install -r requirements.txt > on Windows

5. Build the site and make it available on a local server.

mkdocs serve

6. Browse to http://localhost:8000

MkDocs will then run a local web server at http://localhost:8000, rebuilding the site any time you make a change. You can exit at any time by pressing (CTRL+C).

You can also build the manual as a static site for offline use using the commands shown below:

export OFFLINE=true # OR < set OFFLINE=true > on Windows
export CI=false
mkdocs build

The built manual will be located in the site/ directory. You will now be able to use the search feature offline.

When done, you can exit your virtual environment with the following command:

deactivate