Documentation infrastructure update for MC files

AVSLab · Nov 6, 2024 · 0e33f5f · 0e33f5f
1 parent 3cc5239
commit 0e33f5f
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 12 deletions.
diff --git a/docs/source/Support/bskReleaseNotes.rst b/docs/source/Support/bskReleaseNotes.rst
@@ -44,6 +44,13 @@ Version  |release|
 - Updated :ref:`examples` to better include folders of scenario tutorial scripts
 - Updated documentation build to use latest version of ``sphinx`` and ``sphinx_rtd_theme``.
   Updated the install documenation and optional package requirements.
+- Updated :ref:`MonteCarloExamples` directory with a bokeh plotting feature robust to large Monte Carlo datasets
+- Updated :ref:`scenarioVisualizeMonteCarlo` to autogenerate live bokeh plots in Sphinx documentation
+- Updated :ref:`scenarioMonteCarloAttRW` to include the new ``use_bokeh`` feature in the ``run()`` method
+- Updated :ref:`scenarioMonteCarloAttRW` to use more pythonic OOP for Monte Carlo data retention
+- Updated :ref:`scenarioMonteCarloSpice` to use more pythonic OOP for Monte Carlo data retention
+- Removed the now deprecated ``datashader_utilities.py`` in favor of the new bokeh plotting features in ``AnalysisBaseClass.py``
+
 
 Version 2.5.0 (Sept. 30, 2024)
 ------------------------------
@@ -734,7 +741,7 @@ Version 2.1.0 (Nov. 13, 2021)
 - Fixed a rare issue where RW data didn't stick
 - Fixed an issue subscribing to a C++ wrapped message object from python
 - Cleaned up documentation on using datashaders and bokeh to interactively plot large simulation data sets.
-  The script :ref:`scenarioAnalyzeMonteCarlo` is updated to discuss the particular challenges in running this
+  The script ``scenarioAnalyzeMonteCarlo`` is updated to discuss the particular challenges in running this
   datashader example of plotting data.
 - enable Monte Carlo ``pytest`` test scripts to run on macOS if Python 3.9 or higher is used
 - enable opNav scenario ``pytest`` test scripts to be tested by ``pytest`` if the build flag ``--opNav``

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -84,8 +84,7 @@
     'examples/OpNavScenarios/scenariosOpNav/index.rst',
     'examples/OpNavScenarios/scenariosOpNav/CNN_ImageGen/index.rst',
     'examples/OpNavScenarios/scenariosOpNav/OpNavMC/index.rst',
-    'examples/OpNavScenarios/index.rst',
-    'examples/MonteCarloExamples/index.rst'
+    'examples/OpNavScenarios/index.rst'
 ]
 
 # The name of the Pygments (syntax highlighting) style to use.

diff --git a/examples/MonteCarloExamples/scenarioRerunMonteCarlo.py b/examples/MonteCarloExamples/scenarioRerunMonteCarlo.py
@@ -1,7 +1,7 @@
 #
 #  ISC License
 #
-#  Copyright (c) 2024, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
+#  Copyright (c) 2016, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
 #
 #  Permission to use, copy, modify, and/or distribute this software for any
 #  purpose with or without fee is hereby granted, provided that the above

diff --git a/examples/_default.rst b/examples/_default.rst
@@ -381,9 +381,7 @@ Monte Carlo Simulations
 
    MC run with RW control  <scenarioMonteCarloAttRW>
    MC run using Python Spice setup  <scenarioMonteCarloSpice>
-   MC run using BSK Sim Framework  <MonteCarloExamples/scenario_AttFeedbackMC>
-   MC rerun using prior MC run parameters  <MonteCarloExamples/scenarioRerunMonteCarlo>
-   MC Plotting using datashaders and bokeh  <MonteCarloExamples/scenarioAnalyzeMonteCarlo>
+   MC bskSim example folder with bokeh visualization <MonteCarloExamples/index>
    Sensitivity Analysis of a differential drag spacecraft control <scenarioDragSensitivity>
 
 

diff --git a/examples/scenarioMonteCarloAttRW.py b/examples/scenarioMonteCarloAttRW.py
@@ -1,7 +1,7 @@
 #
 #  ISC License
 #
-#  Copyright (c) 2024, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
+#  Copyright (c) 2016, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
 #
 #  Permission to use, copy, modify, and/or distribute this software for any
 #  purpose with or without fee is hereby granted, provided that the above

diff --git a/examples/scenarioMonteCarloSpice.py b/examples/scenarioMonteCarloSpice.py
@@ -1,7 +1,7 @@
 #
 #  ISC License
 #
-#  Copyright (c) 2024, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
+#  Copyright (c) 2016, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
 #
 #  Permission to use, copy, modify, and/or distribute this software for any
 #  purpose with or without fee is hereby granted, provided that the above

diff --git a/src/tests/test_bskMcTestScript.py b/src/tests/test_bskMcTestScript.py
@@ -1,7 +1,7 @@
 #
 #  ISC License
 #
-#  Copyright (c) 2024, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
+#  Copyright (c) 2016, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
 #
 #  Permission to use, copy, modify, and/or distribute this software for any
 #  purpose with or without fee is hereby granted, provided that the above
@@ -22,6 +22,7 @@
 #
 # Purpose:  This script calls a series of bskSim Monte Carlo related simulations to ensure
 # that they complete properly.
+# Creation Date: Nov 18, 2019
 # Recenlty updated: Nov 4, 2024
 #
 

diff --git a/src/tests/test_scenarioMonteCarloAttRW.py b/src/tests/test_scenarioMonteCarloAttRW.py
@@ -1,7 +1,7 @@
 #
 #  ISC License
 #
-#  Copyright (c) 2024, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
+#  Copyright (c) 2016, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
 #
 #  Permission to use, copy, modify, and/or distribute this software for any
 #  purpose with or without fee is hereby granted, provided that the above

diff --git a/src/tests/test_scenarioMonteCarloSpice.py b/src/tests/test_scenarioMonteCarloSpice.py
@@ -1,7 +1,7 @@
 #
 #  ISC License
 #
-#  Copyright (c) 2024, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
+#  Copyright (c) 2016, Autonomous Vehicle Systems Lab, University of Colorado at Boulder
 #
 #  Permission to use, copy, modify, and/or distribute this software for any
 #  purpose with or without fee is hereby granted, provided that the above