From fdf76b6d8aa4d5b1a3b60b51a0e5a08272834e9a Mon Sep 17 00:00:00 2001 From: Natsoulas Date: Tue, 26 Nov 2024 23:43:07 -0800 Subject: [PATCH] update ReleaseNotes and KnownIssues --- docs/source/Support/bskKnownIssues.rst | 5 ++++- docs/source/Support/bskReleaseNotes.rst | 28 +++++++++++++++---------- 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/docs/source/Support/bskKnownIssues.rst b/docs/source/Support/bskKnownIssues.rst index 58256a89a0..e3d559a3e9 100644 --- a/docs/source/Support/bskKnownIssues.rst +++ b/docs/source/Support/bskKnownIssues.rst @@ -12,7 +12,10 @@ Version |release| ----------------- - pip-based installation in editable mode using ``pip install -e .`` is not currently supported. Developers and users alike should continue to use ``python conanfile.py`` installation. - +- When using `senNoiseStd()` to set the sensor noise standard deviations + in :ref:`magnetometer` and :ref:`coarsesunsensor` + the value was being multiplied by 1.5 when creating the diagonal noise matrix. + This 1.5x multiplier has now been removed. This is corrected in current release. Version 2.5.0 ------------- diff --git a/docs/source/Support/bskReleaseNotes.rst b/docs/source/Support/bskReleaseNotes.rst index c082052543..5cc57d4760 100644 --- a/docs/source/Support/bskReleaseNotes.rst +++ b/docs/source/Support/bskReleaseNotes.rst @@ -62,6 +62,12 @@ Version |release| :ref:`scenarioRoboticArm` scenarios. - Fixed issue in which reading ``RWModel`` from RW message payloads when :ref:`vizInterface` was also imported would return a Swig Object instead of an enumerated integer. +- Refactored the ``GaussMarkov`` class to enforce walk bounds and remove the need for the 1.5x noise multiplier. + Note: Existing code that used this multiplier will need to be updated to maintain the same behavior. +- Removed the deprecated 1.5x multiplier in :ref:`magnetometer` and :ref:`coarsesunsensor` when setting 'senNoiseStd' +- Updated ``starTracker`` unit tests to properly convert EP's to rotation vector now that random walk exists +- Added :ref:`scenarioGaussMarkovRandomWalk` to showcase ``GaussMarkov`` class functionality + Version 2.5.0 (Sept. 30, 2024) @@ -1694,7 +1700,7 @@ Jupiter using a patched-conic Delta_v
  • -Added the first image processing FSW module using OpenCV’s HoughCirlces. +Added the first image processing FSW module using OpenCV's HoughCirlces. .. raw:: html @@ -2123,7 +2129,7 @@ Visualization.
  • -updated the ‘oeStateEphem()’ module to fit radius at periapses instead +updated the 'oeStateEphem()' module to fit radius at periapses instead of SMA, and have the option to fit true versus mean anomaly angles. .. raw:: html @@ -2135,7 +2141,7 @@ of SMA, and have the option to fit true versus mean anomaly angles.
  • updated -’sunlineSuKF\ ``module which provides a switch Sunline UKF estimation filter. New documentation and unit tests.
  • updated 'MRP_Steering' module documentation and unit tests
  • updated orbital motion library functions``\ rv2elem()\ ``and elem2rv()`` +'sunlineSuKF\ ``module which provides a switch Sunline UKF estimation filter. New documentation and unit tests.
  • updated 'MRP_Steering' module documentation and unit tests
  • updated orbital motion library functions``\ rv2elem()\ ``and elem2rv()`` .. raw:: html @@ -2401,7 +2407,7 @@ updated Documentation on ``rwNullSpace`` FSW module updated how the FSW and Simulation modules are displayed with the DOxygen HTML documenation, as well as how the messages are shown. Now -the use can click on the “Modules” tab in the web page to find a cleaner +the use can click on the "Modules" tab in the web page to find a cleaner listing of all BSK modules, messages, utilities and architecture documentation. @@ -2458,7 +2464,7 @@ updated documentation and unit tests of ``cssComm()`` module Integrated the ``conan`` package management system. This requires conan to be installed and configured. See the updated Basilisk installation instructions. It is simple to add this to a current install. Further, -the CMake GUI application can’t be used directly with this +the CMake GUI application can't be used directly with this implementation if the app is double-clicked. Either the GUI is launched form a terminal (see macOS installation instructions), or ``cmake`` is run from the command line (again see your platform specific installation @@ -3079,7 +3085,7 @@ sun-pointing control while the spacecraft goes through a planets shadow. Improved how the ``fuelSloshSpringMassDamper`` effector class works. It is now renamed to ``LinearSpringMassDamper``. It can be used to simulate both fuel sloshing, but also structural modes. If the -``LinearSpringMassDamper`` is connected to a fuel tank, then it’s mass +``LinearSpringMassDamper`` is connected to a fuel tank, then it's mass depends on the amount of fuel left. The associated unit test illustrated how to setup this last capability. The module also contains documentation on the associated math. @@ -3509,7 +3515,7 @@ Added CSS sun-heading estimation tutorial script
  • -Added O’Keefe CSS sun-heading estimation module +Added O'Keefe CSS sun-heading estimation module .. raw:: html @@ -3844,7 +3850,7 @@ module
  • The CSS modules now use the planetary shadow message information to -simulated being in a planet’s shadow +simulated being in a planet's shadow .. raw:: html @@ -3881,7 +3887,7 @@ documentation on using these libraries in Updated the RW and gravitational body (i.e. adding Earth, sun, etc. to the simulation) to use new factory classes. If you did use the older -``simIncludeRW.py`` or ``simIncludeGravity.py`` libraries, you’ll need +``simIncludeRW.py`` or ``simIncludeGravity.py`` libraries, you'll need to update your python code to work with the new factory classes. .. raw:: html @@ -4023,7 +4029,7 @@ sets the proper B point position and velocity vectors. Specifying the initial spacecraft position and velocity states can now be done anywhere before the BSK initialization. The user sets init versions of the position and velocity vectors. The setState() method on -the state engine thus doesn’t have to be used. +the state engine thus doesn't have to be used. .. raw:: html @@ -4087,7 +4093,7 @@ now been removed as they are no longer needed.
  • The position and velocity of the center of mass of the spacecraft was -added to the messaging system, so now the spacecraft’s translational +added to the messaging system, so now the spacecraft's translational states can be logged by the center of mass of the spacecraft (r_CN_N and v_CN_N) or the origin of the body frame which is fixed to the hub (r_BN_N and v_BN_N). Additionally, the mass properties of the spacecraft