Skip to content

Add an option --outputpath to the JSBSim scripts #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bcoconni merged 3 commits into from
Jun 21, 2026
Merged

Add an option --outputpath to the JSBSim scripts #1478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3006bd3
Add an option `--outputpath` to the scripts.
bcoconni Jun 21, 2026
ee2f169
Fix the order of the arguments in the help message.
bcoconni Jun 21, 2026
bfdcd3d
Replace `<filename>` with `<path>`.
bcoconni Jun 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions python/JSBSim.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,29 @@
import time
import xml.etree.ElementTree as et

import _jsbsim
import jsbsim

def main():
parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
parser.add_argument("input", nargs='?', help="script file name")
parser.add_argument("--version", action="version",
version="%(prog)s {}".format(_jsbsim.FGJSBBase().get_version()))
parser.add_argument("--outputlogfile", action="append", metavar="<filename>",
help="sets (overrides) the name of a data output file")
parser.add_argument("--logdirectivefile", action="append", metavar="<filename>",
help="specifies the name of a data logging directives file")
version=f"{jsbsim.FGJSBBase().get_version()}")
parser.add_argument("--root", default='.', metavar="<path>",
help="specifies the JSBSim root directory (where aircraft/, engine/, etc. reside)")
parser.add_argument("--aircraft", metavar="<filename>",
help="specifies the name of the aircraft to be modeled")
parser.add_argument("--script", metavar="<filename>",
help="specifies a script to run")
parser.add_argument("--initfile", metavar="<filename>",
help="specifies an initialization file")
parser.add_argument("--planet", metavar="<filename>",
help="specifies a planet definition file")
parser.add_argument("--outputlogfile", action="append", metavar="<filename>",
help="sets (overrides) the name of a data output file")
parser.add_argument("--logdirectivefile", action="append", metavar="<filename>",
help="specifies the name of a data logging directives file")
parser.add_argument("--outputpath", metavar="<path>",
help="specifies the directory where the output files will be written.")
parser.add_argument("--realtime", default=False, action="store_true",
help="specifies to run in real world time")
parser.add_argument("--nice", default=False, action="store_true",
Expand All @@ -52,10 +58,6 @@ def main():
help="specifies that console output should be pure text only (no color)")
parser.add_argument("--suspend", default=False, action="store_true",
help="specifies to suspend the simulation after initialization")
parser.add_argument("--initfile", metavar="<filename>",
help="specifies an initialization file")
parser.add_argument("--planet", metavar="<filename>",
help="specifies a planet definition file")
parser.add_argument("--catalog", default=False, action="store_true",
help="specifies that all properties for this aircraft model should be printed")
parser.add_argument("--property", action="append", metavar="<name=value>",
Expand Down Expand Up @@ -113,11 +115,16 @@ def CheckXMLFile(f):
else:
args.aircraft = args.input

fdm = _jsbsim.FGFDMExec(args.root, None)
fdm = jsbsim.FGFDMExec(args.root, None)

if args.nohighlight:
fdm.disable_highlighting()

if args.outputpath:
fdm.set_output_path(args.outputpath)
else:
fdm.set_output_path(".")

if args.simulation_rate:
if args.simulation_rate < 1.0:
fdm.set_dt(args.simulation_rate)
Expand Down
22 changes: 16 additions & 6 deletions src/JSBSim.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ GLOBAL DATA
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

SGPath RootDir;
SGPath OutputPath;
SGPath ScriptName;
string AircraftName;
SGPath ResetName;
Expand Down Expand Up @@ -364,6 +365,7 @@ int real_main(int argc, char* argv[])
AircraftName = "";
ResetName = "";
PlanetName = "";
OutputPath = SGPath(".");
LogOutputName.clear();
LogDirectiveName.clear();
bool result = false, success;
Expand Down Expand Up @@ -394,7 +396,7 @@ int real_main(int argc, char* argv[])
FDMExec->SetAircraftPath(SGPath("aircraft"));
FDMExec->SetEnginePath(SGPath("engine"));
FDMExec->SetSystemsPath(SGPath("systems"));
FDMExec->SetOutputPath(SGPath("."));
FDMExec->SetOutputPath(OutputPath);
FDMExec->GetPropertyManager()->Tie("simulation/frame_start_time", &actual_elapsed_time);
FDMExec->GetPropertyManager()->Tie("simulation/cycle_duration", &cycle_duration);

Expand Down Expand Up @@ -712,6 +714,13 @@ bool options(int count, char **arg)
gripe;
exit(1);
}
} else if (keyword == "--outputpath") {
if (n != string::npos) {
OutputPath = SGPath::fromLocal8Bit(value.c_str());
} else {
gripe;
exit(1);
}
} else if (keyword == "--aircraft") {
if (n != string::npos) {
AircraftName = value;
Expand Down Expand Up @@ -842,18 +851,19 @@ void PrintHelp(void)
cout << " options:" << endl;
cout << " --help returns this message" << endl;
cout << " --version returns the version number" << endl;
cout << " --outputlogfile=<filename> sets (overrides) the name of a data output file" << endl;
cout << " --logdirectivefile=<filename> specifies the name of a data logging directives file" << endl;
cout << " (can appear multiple times)" << endl;
cout << " --root=<path> specifies the JSBSim root directory (where aircraft/, engine/, etc. reside)" << endl;
cout << " --aircraft=<filename> specifies the name of the aircraft to be modeled" << endl;
cout << " --script=<filename> specifies a script to run" << endl;
cout << " --initfile=<filename> specifies an initialization file" << endl;
cout << " --planet=<filename> specifies a planet definition file" << endl;
cout << " --outputlogfile=<filename> sets (overrides) the name of a data output file" << endl;
cout << " --logdirectivefile=<filename> specifies the name of a data logging directives file" << endl;
cout << " (can appear multiple times)" << endl;
cout << " --outputpath=<path> specifies the directory where the output files will be written." << endl;
cout << " --realtime specifies to run in actual real world time" << endl;
cout << " --nice specifies to run at lower CPU usage" << endl;
cout << " --nohighlight specifies that console output should be pure text only (no color)" << endl;
cout << " --suspend specifies to suspend the simulation after initialization" << endl;
cout << " --initfile=<filename> specifies an initialization file" << endl;
cout << " --planet=<filename> specifies a planet definition file" << endl;
cout << " --catalog specifies that all properties for this aircraft model should be printed" << endl;
cout << " (catalog=aircraftname is an optional format)" << endl;
cout << " --property=<name=value> e.g. --property=simulation/integrator/rate/rotational=1" << endl;
Expand Down
Loading