Skip to content

Commit

Permalink
reconcile bokeh html autogen with sphinx rst docs autogen
Browse files Browse the repository at this point in the history
  • Loading branch information
Natsoulas committed Oct 22, 2024
1 parent 6389d80 commit c8aa8b2
Show file tree
Hide file tree
Showing 14 changed files with 448 additions and 311 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
commits organized? -->

## Verification
<!-- How were the changes validated? Were any automated tests added, updated, removed, or re-baselined? If you didn't
<!-- How were the changes validated? Were any automated tests added, updated, removed, or re-baselined? If you didn't
add or update any tests justify this choice. -->

## Documentation
<!-- What documentation was invalidated by these changes? Which artifacts should reviewers check for accuracy and
<!-- What documentation was invalidated by these changes? Which artifacts should reviewers check for accuracy and
completeness? -->

## Future work
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ venv/
build/

# Monte Carlo ignore generated data files and test init file.
examples/MonteCarloExamples/scenario_AttFeedbackMC/
examples/MonteCarloExamples/scenarioBskSimAttFeedbackMC/
src/utilities/tests/__init__.py
examples/montecarlo_test*/
2 changes: 1 addition & 1 deletion docs/source/Support/bskReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,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 :ref:`scenarioVisualizeMonteCarlo` 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``
Expand Down
2 changes: 1 addition & 1 deletion examples/BskSim/scenarios/scenario_AttFeedback.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
class scenario_AttFeedback(BSKSim, BSKScenario):
def __init__(self):
super(scenario_AttFeedback, self).__init__()
self.name = 'scenario_AttFeedbackMC'
self.name = 'scenarioBskSimAttFeedbackMC'

# declare additional class variables
self.msgRecList = {}
Expand Down
150 changes: 0 additions & 150 deletions examples/MonteCarloExamples/scenarioAnalyzeMonteCarlo.py

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,18 @@
-----------
1. Ensure you have Basilisk installed with all required dependencies.
2. Run this script directly to execute the Monte Carlo simulations:
python scenario_AttFeedbackMC.py
python scenarioBskSimAttFeedbackMC.py
3. The script will run 20 Monte Carlo simulations by default.
4. Results will be saved in the 'scenario_AttFeedbackMC' directory within the script's location.
4. Results will be saved in the 'scenarioBskSimAttFeedbackMC' directory within the script's location.
Monte Carlo Configuration:
--------------------------
- Simulation Function: Uses `scenario_AttFeedback.scenario_AttFeedback` to set up the base scenario.
- Execution Function: Uses `scenario_AttFeedback.runScenario` to run each simulation.
- Execution Count: Set to 20 simulations.
- Archive Directory: Results are saved in 'scenario_AttFeedbackMC'.
- Archive Directory: Results are saved in 'scenarioBskSimAttFeedbackMC'.
- Seed Dispersion: Enabled to randomize the seed for each module.
- Variable Casting: Downcasts retained numbers to float32 to save storage space.
- Dispersion Magnitude File: Produces a .txt file showing dispersion in standard deviation units.
Expand Down Expand Up @@ -110,9 +110,9 @@ def run(show_plots):
monteCarlo = Controller()
monteCarlo.setSimulationFunction(scenario_AttFeedback.scenario_AttFeedback) # Required: function that configures the base scenario
monteCarlo.setExecutionFunction(scenario_AttFeedback.runScenario) # Required: function that runs the scenario
monteCarlo.setExecutionCount(20) # Required: Number of MCs to run
monteCarlo.setExecutionCount(4) # Required: Number of MCs to run

monteCarlo.setArchiveDir(path + "/scenario_AttFeedbackMC") # Optional: If/where to save retained data.
monteCarlo.setArchiveDir(path + "/scenarioBskSimAttFeedbackMC") # Optional: If/where to save retained data.
monteCarlo.setShouldDisperseSeeds(True) # Optional: Randomize the seed for each module
# monteCarlo.setThreadCount(2) # Optional: Number of processes to spawn MCs on, automatically sizes for personal computer.
# monteCarlo.setVerbose(True) # Optional: Produce supplemental text output in console describing status
Expand Down
5 changes: 2 additions & 3 deletions examples/MonteCarloExamples/scenarioRerunMonteCarlo.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
This script is a basic demonstration of a script that can be used to rerun a set or subset of Monte Carlo simulations.
.. important::
This script can only be run once there exists data produced by the ``scenario_AttFeedbackMC.py`` script.
This script can only be run once there exists data produced by the ``scenarioBskSimAttFeedbackMC.py`` script.
"""
Expand Down Expand Up @@ -88,7 +88,7 @@ def run(time=None):
# Step 4: Add any additional retention policies desired
retentionPolicy = RetentionPolicy()
retentionPolicy.logRate = int(2E9)
retentionPolicy.addMessageLog("attGuidMsg", ["sigma_BR"])
retentionPolicy.addMessageLog("attGuidMsg", ["sigma_BR"])
monteCarlo.addRetentionPolicy(retentionPolicy)


Expand All @@ -99,4 +99,3 @@ def run(time=None):

if __name__ == "__main__":
run()

Loading

0 comments on commit c8aa8b2

Please sign in to comment.