Skip to content

Commit af24174

Browse files
committed
update ReleaseNotes and KnownIssues
1 parent db7dc3f commit af24174

File tree

2 files changed

+22
-12
lines changed

2 files changed

+22
-12
lines changed

docs/source/Support/bskKnownIssues.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ Version |release|
1212
-----------------
1313
- pip-based installation in editable mode using ``pip install -e .`` is not currently supported.
1414
Developers and users alike should continue to use ``python conanfile.py`` installation.
15-
15+
- When using `senNoiseStd()` to set the sensor noise standard deviations
16+
in :ref:`magnetometer` and :ref:`coarsesunsensor`
17+
the value was being multiplied by 1.5 when creating the diagonal noise matrix.
18+
This 1.5x multiplier has now been removed. This is corrected in current release.
1619

1720
Version 2.5.0
1821
-------------

docs/source/Support/bskReleaseNotes.rst

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@ Version |release|
6262
:ref:`scenarioRoboticArm` scenarios.
6363
- Fixed issue in which reading ``RWModel`` from RW message payloads when :ref:`vizInterface` was also
6464
imported would return a Swig Object instead of an enumerated integer.
65+
- Refactored the ``GaussMarkov`` class to enforce walk bounds and remove the need for the 1.5x noise multiplier.
66+
Note: Existing code that used this multiplier will need to be updated to maintain the same behavior.
67+
- Removed the deprecated 1.5x multiplier in :ref:`magnetometer` and :ref:`coarsesunsensor` when setting 'senNoiseStd'
68+
- Updated ``starTracker`` unit tests to properly convert EP's to rotation vector now that random walk exists
69+
- Added :ref:`scenarioGaussMarkovRandomWalk` to showcase ``GaussMarkov`` class functionality
70+
- Added unit test coverage for ``GaussMarkov`` implementation in :ref:`tempMeasurement`,
71+
:ref:`simpleNav` and :ref:`planetNav`.
6572

6673

6774
Version 2.5.0 (Sept. 30, 2024)
@@ -1694,7 +1701,7 @@ Jupiter using a patched-conic Delta_v
16941701

16951702
<li>
16961703

1697-
Added the first image processing FSW module using OpenCVs HoughCirlces.
1704+
Added the first image processing FSW module using OpenCV's HoughCirlces.
16981705

16991706
.. raw:: html
17001707

@@ -2123,7 +2130,7 @@ Visualization.
21232130

21242131
<li>
21252132

2126-
updated the oeStateEphem() module to fit radius at periapses instead
2133+
updated the 'oeStateEphem()' module to fit radius at periapses instead
21272134
of SMA, and have the option to fit true versus mean anomaly angles.
21282135

21292136
.. raw:: html
@@ -2135,7 +2142,7 @@ of SMA, and have the option to fit true versus mean anomaly angles.
21352142
<li>
21362143

21372144
updated
2138-
sunlineSuKF\ ``module which provides a switch Sunline UKF estimation filter. New documentation and unit tests. </li> <li> updated 'MRP_Steering' module documentation and unit tests </li> <li> updated orbital motion library functions``\ rv2elem()\ ``and elem2rv()``
2145+
'sunlineSuKF\ ``module which provides a switch Sunline UKF estimation filter. New documentation and unit tests. </li> <li> updated 'MRP_Steering' module documentation and unit tests </li> <li> updated orbital motion library functions``\ rv2elem()\ ``and elem2rv()``
21392146

21402147
.. raw:: html
21412148

@@ -2401,7 +2408,7 @@ updated Documentation on ``rwNullSpace`` FSW module
24012408

24022409
updated how the FSW and Simulation modules are displayed with the
24032410
DOxygen HTML documenation, as well as how the messages are shown. Now
2404-
the use can click on the Modules tab in the web page to find a cleaner
2411+
the use can click on the "Modules" tab in the web page to find a cleaner
24052412
listing of all BSK modules, messages, utilities and architecture
24062413
documentation.
24072414

@@ -2458,7 +2465,7 @@ updated documentation and unit tests of ``cssComm()`` module
24582465
Integrated the ``conan`` package management system. This requires conan
24592466
to be installed and configured. See the updated Basilisk installation
24602467
instructions. It is simple to add this to a current install. Further,
2461-
the CMake GUI application cant be used directly with this
2468+
the CMake GUI application can't be used directly with this
24622469
implementation if the app is double-clicked. Either the GUI is launched
24632470
form a terminal (see macOS installation instructions), or ``cmake`` is
24642471
run from the command line (again see your platform specific installation
@@ -3079,7 +3086,7 @@ sun-pointing control while the spacecraft goes through a planets shadow.
30793086
Improved how the ``fuelSloshSpringMassDamper`` effector class works. It
30803087
is now renamed to ``LinearSpringMassDamper``. It can be used to simulate
30813088
both fuel sloshing, but also structural modes. If the
3082-
``LinearSpringMassDamper`` is connected to a fuel tank, then its mass
3089+
``LinearSpringMassDamper`` is connected to a fuel tank, then it's mass
30833090
depends on the amount of fuel left. The associated unit test illustrated
30843091
how to setup this last capability. The module also contains
30853092
documentation on the associated math.
@@ -3509,7 +3516,7 @@ Added CSS sun-heading estimation tutorial script
35093516

35103517
<li>
35113518

3512-
Added OKeefe CSS sun-heading estimation module
3519+
Added O'Keefe CSS sun-heading estimation module
35133520

35143521
.. raw:: html
35153522

@@ -3844,7 +3851,7 @@ module
38443851
<li>
38453852

38463853
The CSS modules now use the planetary shadow message information to
3847-
simulated being in a planets shadow
3854+
simulated being in a planet's shadow
38483855

38493856
.. raw:: html
38503857

@@ -3881,7 +3888,7 @@ documentation on using these libraries in
38813888

38823889
Updated the RW and gravitational body (i.e. adding Earth, sun, etc. to
38833890
the simulation) to use new factory classes. If you did use the older
3884-
``simIncludeRW.py`` or ``simIncludeGravity.py`` libraries, youll need
3891+
``simIncludeRW.py`` or ``simIncludeGravity.py`` libraries, you'll need
38853892
to update your python code to work with the new factory classes.
38863893

38873894
.. raw:: html
@@ -4023,7 +4030,7 @@ sets the proper B point position and velocity vectors.
40234030
Specifying the initial spacecraft position and velocity states can now
40244031
be done anywhere before the BSK initialization. The user sets init
40254032
versions of the position and velocity vectors. The setState() method on
4026-
the state engine thus doesnt have to be used.
4033+
the state engine thus doesn't have to be used.
40274034

40284035
.. raw:: html
40294036

@@ -4087,7 +4094,7 @@ now been removed as they are no longer needed.
40874094
<li>
40884095

40894096
The position and velocity of the center of mass of the spacecraft was
4090-
added to the messaging system, so now the spacecrafts translational
4097+
added to the messaging system, so now the spacecraft's translational
40914098
states can be logged by the center of mass of the spacecraft (r_CN_N and
40924099
v_CN_N) or the origin of the body frame which is fixed to the hub
40934100
(r_BN_N and v_BN_N). Additionally, the mass properties of the spacecraft

0 commit comments

Comments
 (0)