jsbsim 1.2.2__tar.gz → 1.2.4__tar.gz

{jsbsim-1.2.2/jsbsim.egg-info → jsbsim-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: jsbsim
-Version: 1.2.2
+Version: 1.2.4
 Summary: An open source flight dynamics & control software library
 Home-page: https://github.com/JSBSim-Team/jsbsim
 Author: Jon S. Berndt et al.
@@ -21,8 +21,18 @@ Classifier: Topic :: Games/Entertainment :: Simulation
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: numpy>=1.20
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 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](http://home.flightgear.org/) or other flight simulator.

{jsbsim-1.2.2 → jsbsim-1.2.4}/README.md

@@ -1,9 +1,8 @@
-[![C/C++ build](https://github.com/JSBSim-Team/jsbsim/workflows/C/C++%20build/badge.svg?branch=master&event=push)](https://github.com/bcoconni/jsbsim/actions?query=workflow%3A%22C%2FC%2B%2B+build%22)
+[![C/C++ build](https://github.com/JSBSim-Team/jsbsim/actions/workflows/cpp-python-build.yml/badge.svg)](https://github.com/JSBSim-Team/jsbsim/actions/workflows/cpp-python-build.yml)
 [![PyPI](https://img.shields.io/pypi/v/jsbsim)](https://pypi.org/project/JSBSim)
 [![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/jsbsim)](https://anaconda.org/conda-forge/jsbsim)
-[![PyPI Downloads](https://static.pepy.tech/personalized-badge/jsbsim?period=total&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads)](https://pepy.tech/project/jsbsim)
+[![PyPI Downloads](https://static.pepy.tech/badge/jsbsim/week)](https://pepy.tech/projects/jsbsim)
 [![Downloads GitHub](https://img.shields.io/github/downloads/JSBSim-Team/jsbsim/total?label=Downloads%20GitHub)](https://github.com/JSBSim-Team/jsbsim/releases)
-[![Downloads SourceForge](https://img.shields.io/sourceforge/dt/jsbsim?label=Downloads%20SourceForge)](https://sourceforge.net/projects/jsbsim/files/)
 
 <p align="center">
 <img width="250" heigth="250" src="https://github.com/JSBSim-Team/jsbsim-logo/blob/master/logo_JSBSIM_globe.png">
@@ -25,33 +24,33 @@ Features include:
 
 JSBSim also includes the following bindings:
 
-* A [Python](https://www.python.org) module which provides the exact same features as the C++ library
-* A [Matlab S-Function](https://github.com/JSBSim-Team/jsbsim/blob/master/matlab) that interfaces JSBSim with [MATLAB Simulink](https://fr.mathworks.com/products/simulink.html).
-* An [Unreal Engine plugin](https://github.com/JSBSim-Team/jsbsim/blob/master/UnrealEngine/) to build a connection between the flight dynamics model from JSBSim and the entire virtual environment provided by [Unreal engine](https://www.unrealengine.com).
+* A [Python](https://www.python.org) module which provides the exact same features as the C++ library with Python based simulation samples that can be run on Google Colab [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](#python-module-examples)
+* A [Matlab S-Function](https://github.com/JSBSim-Team/jsbsim/blob/master/matlab/README.md) that interfaces JSBSim with [MATLAB Simulink](https://fr.mathworks.com/products/simulink.html).
+* An [Unreal Engine plugin](https://github.com/JSBSim-Team/jsbsim/blob/master/UnrealEngine/README.md) to build a connection between the flight dynamics model from JSBSim and the entire virtual environment provided by [Unreal engine](https://www.unrealengine.com).
 
 <p align="center">
 <img src="UnrealEngine/UEReferenceApp.png">
 </p>
 
-In 2015, [NASA performed some verification check cases on 7 flight dynamics software **including JSBSim**](https://nescacademy.nasa.gov/flightsim) (the other 6 being NASA in-house software). The results showed that the 7 simulation tools *"were good enough to indicate agreement between a majority of simulation tools for all cases published. Most of the remaining differences are explained and could be reduced with further effort."*
+In 2015, [NASA performed some verification check cases on 7 flight dynamics software **including JSBSim**](https://nescacademy.nasa.gov/flightsim/2015) (the other 6 being NASA in-house software). The results showed that the 7 simulation tools *"were good enough to indicate agreement between a majority of simulation tools for all cases published. Most of the remaining differences are explained and could be reduced with further effort."*
 
 ## Applications and Usages
 
 JSBSim is used in a range of projects among which:
 
 * Unreal Engine's [Antoinette Project](https://www.unrealengine.com/en-US/blog/antoinette-project-tools-to-create-the-next-generation-of-flight-simulators): tools to create the next generation of flight simulators.
-* Flight simulation: [FlightGear](http://www.flightgear.org), [OutTerra](https://www.outerra.com/wfeatures.html), [Skybolt Engine](https://github.com/Piraxus/Skybolt)
-* SITL (Software In The Loop) Drone Autopilot testing : [ArduPilot](https://ardupilot.org/dev/docs/sitl-with-jsbsim.html), [PX4 Autopilot](https://dev.px4.io/master/en/simulation/jsbsim.html), [Paparazzi](https://wiki.paparazziuav.org/wiki/Simulation)
-* Machine Learning Aircraft control: [gym-jsbsim](https://github.com/galleon/gym-jsbsim)
-* [DARPA Virtual Air Combat Competition](https://www.darpa.mil/news-events/2019-10-21) where one of the AI went undefeated in five rounds of mock air combat against an Air Force fighter (see the [video on YouTube](https://www.youtube.com/watch?v=IOJhgC1ksNU)).
+* Flight simulation: [FlightGear](http://www.flightgear.org), [OutTerra](https://www.outerra.com), [Skybolt Engine](https://github.com/Piraxus/Skybolt)
+* SITL (Software In The Loop) Drone Autopilot testing : [ArduPilot](https://ardupilot.org/dev/docs/sitl-with-jsbsim.html), [PX4 Autopilot](https://docs.px4.io/main/en/sim_jsbsim/), [Paparazzi](https://wiki.paparazziuav.org/wiki/Simulation)
+* Machine Learning Aircraft control: [gym-jsbsim](https://github.com/Gor-Ren/gym-jsbsim)
+* [DARPA Virtual Air Combat Competition](https://www.darpa.mil/news/2019/virtual-air-combat-competition) where one of the AI went undefeated in five rounds of mock air combat against an Air Force fighter (see the [video on YouTube](https://www.youtube.com/watch?v=IOJhgC1ksNU)).
 
 ## Academic and Industry Research
 
-JSBSim is also used in academic and industry research ([more than 700 citations referenced by Google Scholar](https://scholar.google.com/scholar?&q=jsbsim) as of May 2023).
+JSBSim is also used in academic and industry research ([more than 1000 citations referenced by Google Scholar](https://scholar.google.com/scholar?&q=jsbsim) as of May 2025).
 
 In 2023 JSBSim was featured in the article ["A deep reinforcement learning control approach for high-performance aircraft"](https://link.springer.com/article/10.1007/s11071-023-08725-y) , by De Marco et al. (2023), _Nonlinear Dynamics_, an International Journal of Nonlinear Dynamics and Chaos in Engineering Systems by Springer (doi: 10.1007/s11071-023-08725-y). The open-access article is available as a PDF here [https://link.springer.com/content/pdf/10.1007/s11071-023-08725-y.pdf](https://link.springer.com/content/pdf/10.1007/s11071-023-08725-y.pdf). The work demonstrates an application of Deep Reinforcement Learning (DRL) to flight control and guidance, leveraging the JSBSim interface to MATLAB/Simulink.
 
-Another more advanced application within the field of Deep Reinforcement Learning is presented in the article ["Hierarchical Reinforcement Learning for Air Combat at DARPA's AlphaDogfight Trials"](https://ieeexplore.ieee.org/document/9950612) by A. P. Pope et al. (2023), _IEEE Transactions on Artificial Intelligence_ (doi: 10.1109/TAI.2022.3222143), featuring a hierarchical reinforcement learning approach. The trained agent was designed alongside of and competed against active fighter pilots, and ultimately defeated a graduate of the United States Air Force's F-16 Weapons Instructor Course in match play. See also the [DARPA Virtual Air Combat Competition](https://www.darpa.mil/news-events/2019-10-21).
+Another more advanced application within the field of Deep Reinforcement Learning is presented in the article ["Hierarchical Reinforcement Learning for Air Combat at DARPA's AlphaDogfight Trials"](https://ieeexplore.ieee.org/document/9950612) by A. P. Pope et al. (2023), _IEEE Transactions on Artificial Intelligence_ (doi: 10.1109/TAI.2022.3222143), featuring a hierarchical reinforcement learning approach. The trained agent was designed alongside of and competed against active fighter pilots, and ultimately defeated a graduate of the United States Air Force's F-16 Weapons Instructor Course in match play. See also the [DARPA Virtual Air Combat Competition](https://www.darpa.mil/news/2019/virtual-air-combat-competition).
 
 # User Guide
 
@@ -59,7 +58,7 @@ Another more advanced application within the field of Deep Reinforcement Learnin
 
 ### Windows
 
-A Windows installer `JSBSim-1.2.1-setup.exe` is available in the [release section](https://github.com/JSBSim-Team/jsbsim/releases/tag/v1.2.1). It installs the 2 executables along with aircraft data and some example scripts:
+A Windows installer `JSBSim-1.2.3-setup.exe` is available in the [release section](https://github.com/JSBSim-Team/jsbsim/releases/tag/v1.2.3). It installs the 2 executables along with aircraft data and some example scripts:
 
 * `JSBSim.exe` which runs FDM simulations.
 * `aeromatic.exe` which builds aircraft definitions from Question/Answer interface
@@ -70,15 +69,15 @@ The Windows installer also contains the files needed to build the JSBSim Matlab
 
 ### Ubuntu Linux
 
-Debian packages for Ubuntu Linux "Focal" 20.04 LTS and "Jammy" 22.04 LTS for 64 bits platforms are also available in the [JSBSim project release section](https://github.com/JSBSim-Team/jsbsim/releases/tag/v1.2.1). There are 3 packages for each platform:
+Debian packages for Ubuntu Linux "Jammy" 22.04 LTS and "Noble" 24.04 LTS for 64 bits platforms are also available in the [JSBSim project release section](https://github.com/JSBSim-Team/jsbsim/releases/tag/v1.2.3). There are 3 packages for each platform:
 
-* `JSBSim_1.2.1-1348.amd64.deb` which installs the executables `JSBSim` and `aeromatic`
-* `JSBSim-devel_1.2.1-1348.amd64.deb` which installs the development resources (headers and libraries)
-* `python3-JSBSim_1.2.1-1348.amd64.deb` which installs the Python module of JSBSim
+* `JSBSim_1.2.3-1561.amd64.deb` which installs the executables `JSBSim` and `aeromatic`
+* `JSBSim-devel_1.2.3-1561.amd64.deb` which installs the development resources (headers and libraries)
+* `python3-JSBSim_1.2.3-1561.amd64.deb` which installs the Python module of JSBSim
 
 ### Python module
 
-JSBSim provides binary wheel packages for its Python module on Windows, Mac OSX and Linux platforms for several Python versions (3.8, 3.9, 3.10, 3.11 and 3.12). These can be installed using either `pip` or `conda`.
+JSBSim provides binary wheel packages for its Python module on Windows, Mac OSX and Linux platforms for several Python versions (3.9, 3.10, 3.11, 3.12 and 3.13). These can be installed using either `pip` or `conda`.
 
 #### Installation with `pip`
 
@@ -122,7 +121,7 @@ At the moment, JSBSim does not provide binaries for platforms other than Windows
 
 ### Aircraft data and example scripts
 
-JSBSim aircraft data and example scripts are automatically installed if you are using [Python wheel packages](https://github.com/bcoconni/jsbsim#python-module). Otherwise, you can get aircraft data and example scripts by downloading either the [zip package](https://github.com/JSBSim-Team/jsbsim/archive/v1.2.1.zip) or the [tar.gz package](https://github.com/JSBSim-Team/jsbsim/archive/v1.2.1.tar.gz).
+JSBSim aircraft data and example scripts are automatically installed if you are using [Python wheel packages](https://github.com/bcoconni/jsbsim#python-module). Otherwise, you can get aircraft data and example scripts by downloading either the [zip package](https://github.com/JSBSim-Team/jsbsim/archive/v1.2.3.zip) or the [tar.gz package](https://github.com/JSBSim-Team/jsbsim/archive/v1.2.3.tar.gz).
 
 ## Quick start
 
@@ -194,6 +193,23 @@ print(jsbsim.get_default_root_dir())
 
 A more elaborate example of Python code is [JSBSim.py](https://github.com/JSBSim-Team/jsbsim/blob/master/python/JSBSim.py), the Python equivalent to `JSBSim.exe`.
 
+## Python module examples
+
+The [examples/python](https://github.com/JSBSim-Team/jsbsim/tree/master/examples/python) directory contains a number of example Python based scripts embedded in Jupyter notebooks demonstrating the use of JSBSim to determine and analyse aircraft performance.
+You can also quickly try it out using Google Colab by clicking on the icon.
+
+- [AoA vs CAS.ipynb](https://github.com/JSBSim-Team/jsbsim/blob/master/examples/python/AoA%20vs%20CAS.ipynb) calculates and plots the AoA (Angle of Attack) versus CAS (Calibrated Air Speed) for level trim for a range in aircraft weight, altitude and cg (center of gravity).
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/JSBSim-Team/jsbsim/blob/master/examples/python/AoA%20vs%20CAS.ipynb)
+
+- [Trim Envelope.ipynb](https://github.com/JSBSim-Team/jsbsim/blob/master/examples/python/Trim%20Envelope.ipynb) calculates a set of trim points for an aircraft over a range of airspeeds and flight path angles. Required thrust and AoA is indicated via a colormap.
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/JSBSim-Team/jsbsim/blob/master/examples/python/Trim%20Envelope.ipynb)
+
+- [Rudder Kick.ipynb](https://github.com/JSBSim-Team/jsbsim/blob/master/examples/python/Rudder%20Kick.ipynb) simulate a pilot performing a rudder kick test with time histories of the control inputs and sideslip angle plotted.
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/JSBSim-Team/jsbsim/blob/master/examples/python/Rudder%20Kick.ipynb)
+
+- [Thrust Vectoring Analysis.ipynb](https://github.com/JSBSim-Team/jsbsim/blob/master/examples/python/Thrust%20Vectoring%20Analysis.ipynb) vary the thrust vector angle to determine the minimum fuel burn for cruise and climb conditions.
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/JSBSim-Team/jsbsim/blob/master/examples/python/Thrust%20Vectoring%20Analysis.ipynb)
+
 # Contributing Source Code Changes
 
 If you would like to contribute source code changes please take a look at the [Contributing Source Code Changes to JSBSim](https://github.com/JSBSim-Team/jsbsim/wiki/Contributing-Source-Code-Changes-to-JSBSim) Wiki page for instructions on how to go about contributing.

{jsbsim-1.2.2 → jsbsim-1.2.4}/_jsbsim.pyx

@@ -4,7 +4,7 @@
 # JSBSim python interface using cython.
 #
 # Copyright (c) 2013 James Goppert
-# Copyright (c) 2014-2025 Bertrand Coconnier
+# Copyright (c) 2014-2026 Bertrand Coconnier
 #
 # This program is free software; you can redistribute it and/or modify it under
 # the terms of the GNU Lesser General Public License as published by the Free
@@ -133,8 +133,7 @@ import sys
 import numpy
 
 
-
-__version__='1.2.2'
+__version__: str = '1.2.4'
 
 
 class BaseError(RuntimeError):
@@ -269,16 +268,23 @@ cdef class FGPropagate:
         return _convertToNumpyVec(deref(self.thisptr).GetUVW())
 
 
+class Attribute(enum.Enum):
+    NO_ATTR = 0
+    READ = 1
+    WRITE = 2
+
+
 cdef class FGPropertyNode:
-    """Class wrapper for property handling."""
+    """A node in a property tree."""
 
-    cdef SGSharedPtr[c_FGPropertyNode] thisptr
+    cdef SGSharedPtr[c_SGPropertyNode] thisptr
 
     def __bool__(self) -> bool:
         """Check if the object is initialized."""
         return self.thisptr.ptr() is not NULL
 
     def __str__(self) -> str:
+        """Print the fully qualified name of a property and its current value."""
         if self.thisptr.ptr() is not NULL:
             return f"Property '{self.get_fully_qualified_name()}' (value: {self.get_double_value()})"
         return "Uninitialized property"
@@ -295,27 +301,31 @@ cdef class FGPropertyNode:
                 raise MemoryError()
             return None
 
+    def __eq__(self, other:FGPropertyNode) -> bool:
+        """Check if the 2 nodes are pointing to the same property."""
+        return self.thisptr.ptr() == other.thisptr.ptr()
+
     def get_name(self) -> str:
-        """Get the name of a node."""
+        """Get the node's simple name as a string."""
         self.__intercept_invalid_pointer()
-        return self.thisptr.ptr().GetName().decode()
+        return self.thisptr.ptr().getNameString().decode()
 
     def get_fully_qualified_name(self) -> str:
-        """Get the fully qualified name of a node This function is very slow, so is probably useful for debugging only."""
-        self.__intercept_invalid_pointer()
-        return self.thisptr.ptr().GetFullyQualifiedName().decode()
+        """Get the fully qualified name of a node.
 
-    def get_node(self, path: str, create: bool = False) -> Optional[FGPropertyNode]:
-        """Get a property node.
+           This function is very slow, so is probably useful for debugging only."""
+        self.__intercept_invalid_pointer()
+        return GetFullyQualifiedName(self.thisptr.ptr()).decode()
 
-           :param path: The path of the node, relative to root.
-           :param create: true to create the node if it doesn't exist.
-           
+    def get_node(self, path: str, create: bool = False) -> Optional[SGPropertyNode]:
+        """Get a pointer to another node by relative path.
 
-           :return: The node, or 0 if none exists and none was created."""
+           :param path: The relative path from the node.
+           :param create: True to create the node if it doesn't exist.
+           :return: The node, or None if it does not exist."""
         self.__intercept_invalid_pointer()
         node = FGPropertyNode()
-        node.thisptr = self.thisptr.ptr().GetNode(path.encode(), create)
+        node.thisptr = self.thisptr.ptr().getNode(path.encode(), create)
         return node.__validate_node_pointer(create)
 
     def get_double_value(self) -> float:
@@ -333,11 +343,19 @@ cdef class FGPropertyNode:
         self.__intercept_invalid_pointer()
         return self.thisptr.ptr().setDoubleValue(value)
 
-cdef class FGPropertyManager:
-    """
-       .. note::
+    def get_attribute(self, attr: Attribute) -> bool:
+        """Check a single mode attribute for the property node."""
+        self.__intercept_invalid_pointer()
+        return self.thisptr.ptr().getAttribute(attr.value)
+
+    def set_attribute(self, attr: Attribute, state: bool) -> None:
+        """Set a single mode attribute for the property node."""
+        self.__intercept_invalid_pointer()
+        self.thisptr.ptr().setAttribute(attr.value ,state)
 
-          This feature is not yet documented."""
+
+cdef class FGPropertyManager:
+    """Class wrapper for property handling."""
 
     cdef shared_ptr[c_FGPropertyManager] thisptr
 
@@ -354,7 +372,7 @@ cdef class FGPropertyManager:
         if not self.thisptr:
             raise MemoryError()
 
-    def get_node(self, path: Optional[str] = None, create: bool = False) -> Optional[FGPropertyNode]:
+    def get_node(self, path: Optional[str] = None, create: bool = False) -> Optional[SGPropertyNode]:
         """
            .. note::
 
@@ -814,6 +832,13 @@ cdef class FGAircraft:
         if not self.thisptr:
             raise BaseError("Object is not initialized")
 
+    def get_aircraft_name(self) -> str:
+        """Gets the aircraft name.
+
+           :return: the name of the aircraft as a string type"""
+        self.__intercept_invalid_pointer()
+        return deref(self.thisptr).GetAircraftName().decode('utf-8')
+
     def get_xyz_rp(self) -> numpy.ndarray:
         """
            .. note::
@@ -1096,7 +1121,7 @@ cdef class FGPropulsion:
         return engine
 
     def get_steady_state(self) -> bool:
-        """Loops the engines until thrust output steady (used for trimming)"""
+        """Loops the engines until thrust output steady (used for trimming)."""
         self.__intercept_invalid_pointer()
         return deref(self.thisptr).GetSteadyState()
 

{jsbsim-1.2.2 → jsbsim-1.2.4}/jsbsim/__init__.py

@@ -1,5 +1,7 @@
+from . import _jsbsim
 from ._jsbsim import (
     __version__,
+    Attribute,
     BaseError,
     FGAerodynamics,
     FGAircraft,

{jsbsim-1.2.2 → jsbsim-1.2.4}/jsbsim/_jsbsim.pxd

@@ -70,20 +70,27 @@ cdef extern from "simgear/structure/SGSharedPtr.hxx":
         SGSharedPtr& operator=[U](U* p)
         T* ptr() const
 
-cdef extern from "input_output/FGPropertyManager.h" namespace "JSBSim":
-    cdef cppclass c_FGPropertyNode "JSBSim::FGPropertyNode":
-        c_FGPropertyNode* GetNode(const string& path, bool create)
-        const string& GetName() const
-        const string& GetFullyQualifiedName() const
+cdef extern from "simgear/props/props.hxx" namespace "JSBSim":
+    cdef enum c_Attribute "SGPropertyNode::Attribute":
+        NO_ATTR = 0,
+        READ = 1,
+        WRITE = 2
+
+    cdef cppclass c_SGPropertyNode "SGPropertyNode":
+        c_SGPropertyNode* getNode(const string& path, bool create)
+        const string& getNameString() const
         double getDoubleValue() const
         bool setDoubleValue(double value)
+        bool getAttribute(c_Attribute attr) const
+        void setAttribute(c_Attribute attr, bool state)
 
 cdef extern from "input_output/FGPropertyManager.h" namespace "JSBSim":
+    cdef string GetFullyQualifiedName(const c_SGPropertyNode* node)
     cdef cppclass c_FGPropertyManager "JSBSim::FGPropertyManager":
         c_FGPropertyManager()
-        c_FGPropertyManager(c_FGPropertyNode* root)
-        c_FGPropertyNode* GetNode()
-        c_FGPropertyNode* GetNode(const string& path, bool create)
+        c_FGPropertyManager(c_SGPropertyNode* root)
+        c_SGPropertyNode* GetNode()
+        c_SGPropertyNode* GetNode(const string& path, bool create)
         bool HasNode(const string& path) except +convertJSBSimToPyExc
 
 cdef extern from "math/FGColumnVector3.h" namespace "JSBSim":
@@ -107,6 +114,7 @@ cdef extern from "models/FGAerodynamics.h" namespace "JSBSim":
 cdef extern from "models/FGAircraft.h" namespace "JSBSim":
     cdef cppclass c_FGAircraft "JSBSim::FGAircraft":
         c_FGAircraft(c_FGFDMExec* fdmex) except +
+        const string GetAircraftName() const
         c_FGColumnVector3& GetXYZrp()
 
 cdef extern from "models/FGAtmosphere.h" namespace "JSBSim":

jsbsim-1.2.4/jsbsim/_jsbsim.pyi

@@ -0,0 +1,202 @@
+from typing import Optional
+import enum
+import errno
+import os
+import site
+import sys
+import numpy
+
+class BaseError(RuntimeError):...
+
+class TrimFailureError(BaseError):...
+
+class GeographicError(BaseError):...
+
+def get_default_root_dir() -> str: ...
+
+def _append_xml(name: str) -> str: ...
+
+class FGPropagate:
+    def __bool__(self) -> bool: ...
+    def get_Tl2b(self) -> numpy.ndarray: ...
+    def get_Tec2b(self) -> numpy.ndarray: ...
+    def get_uvw(self) -> numpy.ndarray: ...
+
+class Attribute(enum.Enum):...
+
+class FGPropertyNode:
+    def __bool__(self) -> bool: ...
+    def __str__(self) -> str: ...
+    def __eq__(self, other: FGPropertyNode) -> bool: ...
+    def get_name(self) -> str: ...
+    def get_fully_qualified_name(self) -> str: ...
+    def get_node(self, path: str, create: bool = False) -> Optional[SGPropertyNode]: ...
+    def get_double_value(self) -> float: ...
+    def set_double_value(self, value: float) -> bool: ...
+    def get_attribute(self, attr: Attribute) -> bool: ...
+    def set_attribute(self, attr: Attribute, state: bool) -> None: ...
+
+class FGPropertyManager:
+    def get_node(self, path: Optional[str] = None, create: bool = False) -> Optional[SGPropertyNode]: ...
+    def hasNode(self, path: str) -> bool: ...
+
+class FGGroundReactions:
+    def __bool__(self) -> bool: ...
+    def get_gear_unit(self, gear: int) -> FGLGear: ...
+    def get_num_gear_units(self) -> int: ...
+
+class FGLGear:
+    def __bool__(self) -> bool: ...
+    def get_steer_norm(self) -> float: ...
+    def get_body_x_force(self) -> float: ...
+    def get_body_y_force(self) -> float: ...
+    def get_body_z_force(self) -> float: ...
+    def get_location(self) -> numpy.ndarray: ...
+    def get_acting_location(self) -> numpy.ndarray: ...
+
+class FGAuxiliary:
+    def __bool__(self) -> bool: ...
+    def get_Tw2b(self) -> numpy.ndarray: ...
+    def get_Tb2w(self) -> numpy.ndarray: ...
+
+class FGAerodynamics:
+    def __bool__(self) -> bool: ...
+    def get_moments_MRC(self) -> numpy.ndarray: ...
+    def get_forces(self) -> numpy.ndarray: ...
+
+class FGAircraft:
+    def __bool__(self) -> bool: ...
+    def get_aircraft_name(self) -> str: ...
+    def get_xyz_rp(self) -> numpy.ndarray: ...
+
+class eTemperature(enum.Enum):...
+
+class ePressure(enum.Enum):...
+
+class FGAtmosphere:
+    def __bool__(self) -> bool: ...
+    def set_temperature(self, t: float, h: float, unit: eTemperature) -> None: ...
+    def get_temperature(self, h: float) -> float: ...
+    def set_pressure_SL(self, unit: ePressure, p: float) -> None: ...
+
+class FGMassBalance:
+    def __bool__(self) -> bool: ...
+    def get_xyz_cg(self) -> numpy.ndarray: ...
+    def get_J(self) -> numpy.ndarray: ...
+    def get_Jinv(self) -> numpy.ndarray: ...
+
+class FGJSBBase:
+    @property
+    def debug_lvl(self) -> None: ...
+    @debug_lvl.setter
+    def debug_lvl(self, dbglvl: int) -> None: ...
+    def get_version(self) -> str: ...
+    def disable_highlighting(self) -> None: ...
+
+class FGPropulsion:
+    def __bool__(self) -> bool: ...
+    def init_running(self, n: int) -> None: ...
+    def get_num_engines(self) -> int: ...
+    def get_engine(self, idx: int) -> FGEngine: ...
+    def get_steady_state(self) -> bool: ...
+
+class FGEngine:
+    def __bool__(self) -> bool: ...
+    def init_running(self) -> int: ...
+
+class FGLinearization:
+    def __bool__(self) -> bool: ...
+    def write_scicoslab(self, path: str) -> None: ...
+    @property
+    def x0(self) -> numpy.ndarray: ...
+    @property
+    def u0(self) -> numpy.ndarray: ...
+    @property
+    def y0(self) -> numpy.ndarray: ...
+    @property
+    def system_matrix(self) -> numpy.ndarray: ...
+    @property
+    def input_matrix(self) -> numpy.ndarray: ...
+    @property
+    def output_matrix(self) -> numpy.ndarray: ...
+    @property
+    def feedforward_matrix(self) -> numpy.ndarray: ...
+    @property
+    def state_space(self) -> tuple[numpy.ndarray]: ...
+    @property
+    def x_names(self) -> tuple[str]: ...
+    @property
+    def u_names(self) -> tuple[str]: ...
+    @property
+    def y_names(self) -> tuple[str]: ...
+    @property
+    def x_units(self) -> tuple[str]: ...
+    @property
+    def u_units(self) -> tuple[str]: ...
+    @property
+    def y_units(self) -> tuple[str]: ...
+
+class FGFDMExec(FGJSBBase):
+    def __repr__(self) -> str: ...
+    def __getitem__(self, key: str) -> float: ...
+    def __setitem__(self, key: str, value: float) -> None: ...
+    def run(self) -> bool: ...
+    def run_ic(self) -> bool: ...
+    def load_model(self, model: str, add_model_to_path: bool = True) -> bool: ...
+    def load_model_with_paths(self, model: str, aircraft_path: str, engine_path: str, systems_path: str, add_model_to_path: bool = True) -> bool: ...
+    def load_script(self, script: str, delta_t: float = 0.0, initfile: str = "") -> bool: ...
+    def load_planet(self, planet_path: str, useAircraftPath: bool) -> bool: ...
+    def set_engine_path(self, path: str) -> bool: ...
+    def set_aircraft_path(self, path: str) -> bool: ...
+    def set_systems_path(self, path: str) -> bool: ...
+    def set_output_path(self, path: str) -> bool: ...
+    def set_root_dir(self, path: str) -> None: ...
+    def get_engine_path(self) -> str: ...
+    def get_aircraft_path(self) -> str: ...
+    def get_systems_path(self) -> str: ...
+    def get_output_path(self) -> str: ...
+    def get_full_aircraft_path(self) -> str: ...
+    def get_root_dir(self) -> str: ...
+    def get_property_value(self, name: str) -> float: ...
+    def set_property_value(self, name: str, value: float) -> None: ...
+    def get_model_name(self) -> str: ...
+    def set_output_directive(self, fname: str) -> bool: ...
+    def set_logging_rate(self, rate: float) -> None: ...
+    def set_output_filename(self, n: int, fname: str) -> bool: ...
+    def get_output_filename(self, n: int) -> str: ...
+    def do_trim(self, mode: int) -> None: ...
+    def disable_output(self) -> None: ...
+    def enable_output(self) -> None: ...
+    def hold(self) -> None: ...
+    def enable_increment_then_hold(self, time_steps: int) -> None: ...
+    def check_incremental_hold(self) -> None: ...
+    def resume(self) -> None: ...
+    def holding(self) -> bool: ...
+    def reset_to_initial_conditions(self, mode: int) -> None: ...
+    def set_debug_level(self, level: int) -> None: ...
+    def query_property_catalog(self, check: str) -> str: ...
+    def get_property_catalog(self) -> list[str]: ...
+    def print_property_catalog(self) -> None: ...
+    def print_simulation_configuration(self) -> None: ...
+    def set_trim_status(self, status: bool) -> None: ...
+    def get_trim_status(self) -> bool: ...
+    def get_propulsion_tank_report(self) -> str: ...
+    def get_sim_time(self) -> float: ...
+    def get_delta_t(self) -> float: ...
+    def suspend_integration(self) -> None: ...
+    def resume_integration(self) -> None: ...
+    def integration_suspended(self) -> bool: ...
+    def set_sim_time(self, time: float) -> bool: ...
+    def set_dt(self, dt: float) -> None: ...
+    def incr_time(self) -> float: ...
+    def get_debug_level(self) -> int: ...
+    def load_ic(self, rstfile: str, useAircraftPath: bool) -> bool: ...
+    def get_propagate(self) -> FGPropagate: ...
+    def get_property_manager(self) -> FGPropertyManager: ...
+    def get_ground_reactions(self) -> FGGroundReactions: ...
+    def get_auxiliary(self) -> FGAuxiliary: ...
+    def get_aerodynamics(self) -> FGAerodynamics: ...
+    def get_aircraft(self) -> FGAircraft: ...
+    def get_mass_balance(self) -> FGMassBalance: ...
+    def get_atmosphere(self) -> FGAtmosphere: ...
+    def get_propulsion(self) -> FGPropulsion: ...

{jsbsim-1.2.2 → jsbsim-1.2.4}/jsbsim/aircraft/737/737.xml

@@ -3,17 +3,16 @@
 <fdm_config name="737" release="BETA" version="2.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="http://jsbsim.sourceforge.net/JSBSim.xsd">
-    
+
     <fileheader>
         <author> Dave Culp </author>
         <author> Aeromatic </author>
-        <filecreationdate> 2006-01-04 </filecreationdate>
+        <license
+          licenseName="GPL (General Public License)"
+          licenseURL="http://www.gnu.org/licenses/gpl.html"/>
+        <filecreationdate>2006-01-04</filecreationdate>
         <version>$Revision: 1.43 $</version>
         <description> Models a Boeing 737. </description>
-        <license>
-          <licenseName>GPL (General Public License)</licenseName>
-          <licenseURL>http://www.gnu.org/licenses/gpl.html</licenseURL>
-        </license>
         <note>
         This model was created using publicly available data, publicly available
         technical reports, textbooks, and guesses. It contains no proprietary or
@@ -115,7 +114,7 @@
             <spring_coeff unit="LBS/FT"> 120000 </spring_coeff>
             <damping_coeff unit="LBS/FT/SEC"> 10000 </damping_coeff>
             <damping_coeff_rebound unit="LBS/FT/SEC">20000</damping_coeff_rebound>
-            
+
             <max_steer unit="DEG"> 0.0 </max_steer>
             <brake_group> RIGHT </brake_group>
             <retractable>1</retractable>
@@ -844,7 +843,7 @@
 
     <!-- 41 properties output, + 1 for the time stamp -->
  <!--output name="localhost" type="SOCKET" port="5138" protocol="UDP" rate="10">
-   
+
   <property> velocities/vc-kts </property>
   <property> position/h-sl-ft </property>
   <property> attitude/theta-deg </property>
@@ -888,23 +887,22 @@
   <property> fcs/speedbrake-pos-norm </property>
   <property> fcs/right-aileron-pos-norm </property>
   <property> fcs/elevator-pos-norm </property>
-  
+
   <property> fcs/rudder-pos-norm </property>
-  
+
  </output-->
 
  <!-- this is the telnet interface -->
- <input port="5137" /> 
- 
+ <input port="5137" />
+
  <!-- 6 properties input, + 1 for the time stamp -->
  <input port="5139" type="QTJSBSIM" rate="20">
-  <property> fcs/aileron-cmd-norm </property> 
-  <property> fcs/elevator-cmd-norm </property> 
-  <property> fcs/rudder-cmd-norm </property> 
-  <property> fcs/throttle-cmd-norm[0] </property> 
+  <property> fcs/aileron-cmd-norm </property>
+  <property> fcs/elevator-cmd-norm </property>
+  <property> fcs/rudder-cmd-norm </property>
+  <property> fcs/throttle-cmd-norm[0] </property>
   <property> fcs/throttle-cmd-norm[1] </property>
-  <property> simulation/terminate </property> 
- </input>  
+  <property> simulation/terminate </property>
+ </input>
 
 </fdm_config>
-