{"id":23744818,"url":"https://github.com/jsbsim-team/jsbsim-reference-manual","last_synced_at":"2026-03-07T14:30:18.561Z","repository":{"id":31231871,"uuid":"127293240","full_name":"JSBSim-Team/jsbsim-reference-manual","owner":"JSBSim-Team","description":"Online JSBSim manual (User, and Programmer Manual)","archived":false,"fork":false,"pushed_at":"2025-01-28T12:02:46.000Z","size":46943,"stargazers_count":21,"open_issues_count":4,"forks_count":16,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-01-28T13:24:54.441Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://jsbsim-team.github.io/jsbsim-reference-manual","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JSBSim-Team.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-29T13:12:06.000Z","updated_at":"2025-01-28T12:02:43.000Z","dependencies_parsed_at":"2024-12-31T12:59:36.073Z","dependency_job_id":null,"html_url":"https://github.com/JSBSim-Team/jsbsim-reference-manual","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JSBSim-Team%2Fjsbsim-reference-manual","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JSBSim-Team%2Fjsbsim-reference-manual/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JSBSim-Team%2Fjsbsim-reference-manual/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JSBSim-Team%2Fjsbsim-reference-manual/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JSBSim-Team","download_url":"https://codeload.github.com/JSBSim-Team/jsbsim-reference-manual/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239898461,"owners_count":19715212,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-31T12:49:20.182Z","updated_at":"2026-03-07T14:30:18.223Z","avatar_url":"https://github.com/JSBSim-Team.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSBSim Reference Manual\n\nThis site is the home of the [JSBSim Reference Manual](https://jsbsim-team.github.io/jsbsim-reference-manual), a website hosted by GitHub Pages, based on [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.\n\n\u003cp align=\"center\"\u003e\n\u003cimg width=\"250\" heigth=\"250\" src=\"https://github.com/JSBSim-Team/jsbsim-logo/blob/master/logo_JSBSIM_globe.png\"\u003e\n\u003c/p\u003e\n\n[JSBSim](https://github.com/JSBSim-Team/jsbsim) is a multi-platform, general purpose object-oriented Flight Dynamics Model (FDM) written in C++. The FDM is essentially the physics \u0026 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](https://www.flightgear.org/) or other flight simulator.\n \n## Contribute\n\n### Report bugs or request features.\n\nIf you want to report bugs or request features/new additions, please [open a new issue](https://github.com/JSBSim-Team/jsbsim-reference-manual/issues).\n\n### Contribute to the documentation\n\nIf you want to contribute to the documentation, please [submit a pull request](https://github.com/JSBSim-Team/jsbsim-reference-manual/pulls)\n\nFor that, you will need to fork this repository and install [Python3](https://www.python.org/) and [pip](https://pip.pypa.io/en/stable/installation/) on your computer.\n\n1. Install the prerequisites mentioned above.\n\n2. Clone the repository.\n```bash\ngit clone https://github.com/JSBSim-Team/jsbsim-reference-manual.git\n```\n\n3. Create an isolated virtual environment.\n```bash\ncd jsbsim-reference-manual\npython3 -m venv env # OR \u003c py -m venv env \u003e on Windows\n```\n\n4. Activate the virtual environment and install required PyPi packages.\n```bash\nsource env/bin/activate # OR \u003c .\\env\\Scripts\\activate \u003e on Windows\npython3 -m pip install -r requirements.txt # OR \u003c py -m pip install -r requirements.txt \u003e on Windows\n```\n\n5. Build the site and make it available on a local server.\n```bash\nmkdocs serve\n```\n\n6. Browse to http://localhost:8000\n\nMkDocs 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`).\n\nYou can also build the manual as a static site for offline use using the commands shown below:\n```bash\nexport OFFLINE=true # OR \u003c set OFFLINE=true \u003e on Windows\nexport CI=false\nmkdocs build\n```\nThe built manual will be located in the *site/* directory. You will now be able to use the search feature offline.\n\nWhen done, you can exit your virtual environment with the following command:\n```bash\ndeactivate\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsbsim-team%2Fjsbsim-reference-manual","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsbsim-team%2Fjsbsim-reference-manual","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsbsim-team%2Fjsbsim-reference-manual/lists"}