Merge pull request #629 from AVSLab/feature/bsk-611-solar-array-deplo…

…yment-scenario Feature/bsk 611 solar array deployment scenario
AVSLab · Mar 8, 2024 · 2ef7f5b · 2ef7f5b
2 parents 6f12949 + 4f3a62a
commit 2ef7f5b
Show file tree

Hide file tree

Showing 8 changed files with 771 additions and 2 deletions.
diff --git a/docs/source/Support/bskReleaseNotes.rst b/docs/source/Support/bskReleaseNotes.rst
@@ -59,6 +59,8 @@ Version |release|
 - Created a :ref:`prescribedRotation1DOF` dynamics module to profile a prescribed 1 DOF rotation for a secondary
   rigid body connected to the spacecraft hub. This new module deprecates the ``prescribedRot1DOF`` fsw module.
   To simulate the rotation, this module must be connected to the :ref:`prescribedMotionStateEffector` dynamics module.
+- Created a new example scenario :ref:`scenarioDeployingSolarArrays` demonstrating how to simulate hub-relative
+  multi-body prescribed motion.
 
 Version 2.2.1 (Dec. 22, 2023)
 -----------------------------

diff --git a/docs/source/_images/static/scenarioDeployingSolarArrays.jpg b/docs/source/_images/static/scenarioDeployingSolarArrays.jpg
diff --git a/examples/_default.rst b/examples/_default.rst
@@ -208,6 +208,7 @@ Complex Spacecraft Dynamics Simulations
    Hinged Panel Deployment <scenarioDeployingPanel>
    MSM Simulation of Charged Spacecraft <scenarioTwoChargedSC>
    Spacecraft with 1- or 2-DOF Panel using single effector <scenarioSpinningBodiesTwoDOF>
+   Prescribed Motion Rotational Solar Array Deployment <scenarioDeployingSolarArrays>
 
 Mission Simulations
 ---------------------------------------

diff --git a/examples/dataForExamples/triangularPanel.obj b/examples/dataForExamples/triangularPanel.obj
@@ -0,0 +1,24 @@
+# Apple ModelIO OBJ File: triangularPanel
+mtllib triangularPanel.mtl
+g 
+v 1.9021 0 -0.05
+v -1.9021 -1.23605 -0.05
+v -1.9021 1.23605 -0.05
+v 1.9021 0 0.05
+v -1.9021 1.23605 0.05
+v -1.9021 -1.23605 0.05
+vn 0 0 -1
+vn 0 0 1
+vn 1 1 0
+vn 1 -1 0
+vn -1 0 0
+usemtl material_1
+f 1//1 2//1 3//1
+f 4//2 5//2 6//2
+f 1//3 3//3 5//3
+f 1//3 5//3 4//3
+f 1//4 4//4 2//4
+f 2//4 4//4 6//4
+f 2//5 6//5 3//5
+f 3//5 6//5 5//5
+s off
diff --git a/examples/scenarioDeployingSolarArrays.py b/examples/scenarioDeployingSolarArrays.py
diff --git a/src/simulation/deviceInterface/prescribedRotation1DOF/prescribedRotation1DOF.rst b/src/simulation/deviceInterface/prescribedRotation1DOF/prescribedRotation1DOF.rst
@@ -23,6 +23,8 @@ meaning that the module defaults to the bang-bang acceleration profile with no c
 .. important::
     To use this module for prescribed motion, it must be connected to the :ref:`PrescribedMotionStateEffector`
     dynamics module. This ensures the spinning body's states are correctly incorporated into the spacecraft dynamics.
+    See the example script :ref:`scenarioDeployingSolarArrays` for more information about how to set up hub-relative
+    multi-body prescribed motion using the state effector module together with this profiler module.
 
 Message Connection Descriptions
 -------------------------------

diff --git a/src/simulation/dynamics/prescribedMotion/prescribedMotionStateEffector.rst b/src/simulation/dynamics/prescribedMotion/prescribedMotionStateEffector.rst
@@ -14,7 +14,9 @@ be connected to this module's :ref:`PrescribedTranslationMsgPayload` and :ref:`P
 input messages to profile the prescribed body's states as a function of time. These message connections are required
 to provide the prescribed body's states to this dynamics module. Note that either a single profiler can be connected to
 these input messages or two separate profiler modules can be used; where one profiles the prescribed body's
-translational states and the other profiles the prescribed body's rotational states.
+translational states and the other profiles the prescribed body's rotational states. See the example script
+:ref:`scenarioDeployingSolarArrays` for more information about how to set up hub-relative
+multi-body prescribed motion using this state effector module and the associated kinematic profiler modules.
 
 Message Connection Descriptions
 -------------------------------
@@ -128,6 +130,7 @@ default.
 
     unitTestSim.AddModelToTask(unitTaskName, platform)
 
-
+See the example script :ref:`scenarioDeployingSolarArrays` for more information about how to set up hub-relative
+multi-body prescribed motion using this state effector module and the associated kinematic profiler modules.
 
 
diff --git a/src/tests/test_scenarioTest.py b/src/tests/test_scenarioTest.py
@@ -65,6 +65,7 @@
                                         , 'scenarioRendezVous'
                                         , 'scenarioSensorThermal'
                                         , 'scenarioHaloOrbit'
+                                        , 'scenarioDeployingSolarArrays'
                                         ])
 @pytest.mark.scenarioTest
 def test_scenarioBskScenarios(show_plots, scenarioCase):