Skip to content

Various architectural and documentation changes#1376

Merged
schaubh merged 7 commits into
developfrom
feature/1366-1367-1368-architecture-changes
May 1, 2026
Merged

Various architectural and documentation changes#1376
schaubh merged 7 commits into
developfrom
feature/1366-1367-1368-architecture-changes

Conversation

@juan-g-bonilla

Copy link
Copy Markdown
Contributor

Description

Refactors mujocoDynamics module layout to follow BSK conventions (one module per folder, abstract base classes in _GeneralModuleFiles):

  • MeanRevertingNoise (abstract base) moved to _GeneralModuleFiles with its own MJMeanRevertingNoise SWIG module
  • StochasticAtmDensity and StochasticDragCoeff each get their own folder and SWIG module (MJStochasticAtmDensity, MJStochasticDragCoeff)
  • PIDControllers/ renamed to JointPIDController/, SWIG module renamed to MJJointPIDController

Commits are organized one module change per commit, with scenario import fixes bundled into the commit that caused them.

Verification

Existing unit tests cover StochasticAtmDensity and JointPIDController. A new unit test was added for StochasticDragCoeff (previously untested). No logic was changed, only file organization and import paths.

Documentation

Added missing .rst pages for NBodyGravity, JointPIDController, StochasticAtmDensity, and StochasticDragCoeff. Updated path references in existing .rst files. Release note snippet added.

Future work

None anticipated.

@juan-g-bonilla juan-g-bonilla self-assigned this Apr 29, 2026
@juan-g-bonilla juan-g-bonilla requested a review from a team as a code owner April 29, 2026 05:13
@juan-g-bonilla juan-g-bonilla added documentation Improvements or additions to documentation refactor Clean up with no new functionality labels Apr 29, 2026
@juan-g-bonilla juan-g-bonilla moved this to 🏗 In progress in Basilisk Apr 29, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4f346d03a5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/simulation/mujocoDynamics/stochasticAtmDensity/stochasticAtmDensity.rst Outdated
@juan-g-bonilla juan-g-bonilla force-pushed the feature/1366-1367-1368-architecture-changes branch 2 times, most recently from 4fdbe23 to 02d5eff Compare April 29, 2026 05:40
@juan-g-bonilla juan-g-bonilla moved this from 🏗 In progress to 👀 In review in Basilisk Apr 29, 2026
@juan-g-bonilla

Copy link
Copy Markdown
Contributor Author

Need to use #1376 instead of #1375 in the commit messages.

@schaubh schaubh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, almost there. Just a few small items to improve the documentation result

Comment thread src/simulation/mujocoDynamics/stochasticAtmDensity/stochasticAtmDensity.rst Outdated
Comment thread src/simulation/mujocoDynamics/stochasticDragCoeff/stochasticDragCoeff.rst Outdated
Comment thread src/simulation/mujocoDynamics/NBodyGravity/NBodyGravity.rst Outdated
Comment thread src/simulation/mujocoDynamics/stochasticAtmDensity/stochasticAtmDensity.rst Outdated
Comment thread src/simulation/mujocoDynamics/stochasticAtmDensity/stochasticAtmDensity.rst Outdated
Comment thread src/simulation/mujocoDynamics/stochasticAtmDensity/stochasticAtmDensity.h Outdated
Comment thread src/simulation/mujocoDynamics/stochasticDragCoeff/stochasticDragCoeff.h Outdated
Moves meanRevertingNoise.h/.cpp to _GeneralModuleFiles where abstract
base classes belong. Creates a dedicated MJMeanRevertingNoise SWIG module
there so Python subclassing of the base class continues to work.
Moves StochasticAtmDensity out of meanRevertingNoise/ into its own
folder with a dedicated MJStochasticAtmDensity SWIG module and .rst.
Updates the unit test and scenarioStochasticDrag to import from the
new module name.
Moves StochasticDragCoeff out of meanRevertingNoise/ into its own
folder with a dedicated MJStochasticDragCoeff SWIG module, .rst,
and a new unit test that validates OU statistics on drag coefficient.
Renames the folder, SWIG module (MJPIDControllers -> MJJointPIDController),
and test file to match the single concrete class it contains. Adds
JointPIDController.rst and updates scenarioBranchingPanels to import
from the new module name.
@juan-g-bonilla juan-g-bonilla force-pushed the feature/1366-1367-1368-architecture-changes branch from 02d5eff to a8ccec9 Compare April 30, 2026 04:39

@schaubh schaubh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beautiful, good to go!!

@schaubh schaubh merged commit 354fbc4 into develop May 1, 2026
7 checks passed
schaubh pushed a commit that referenced this pull request May 1, 2026
Moves meanRevertingNoise.h/.cpp to _GeneralModuleFiles where abstract
base classes belong. Creates a dedicated MJMeanRevertingNoise SWIG module
there so Python subclassing of the base class continues to work.
schaubh pushed a commit that referenced this pull request May 1, 2026
Moves StochasticAtmDensity out of meanRevertingNoise/ into its own
folder with a dedicated MJStochasticAtmDensity SWIG module and .rst.
Updates the unit test and scenarioStochasticDrag to import from the
new module name.
schaubh pushed a commit that referenced this pull request May 1, 2026
Moves StochasticDragCoeff out of meanRevertingNoise/ into its own
folder with a dedicated MJStochasticDragCoeff SWIG module, .rst,
and a new unit test that validates OU statistics on drag coefficient.
schaubh pushed a commit that referenced this pull request May 1, 2026
Renames the folder, SWIG module (MJPIDControllers -> MJJointPIDController),
and test file to match the single concrete class it contains. Adds
JointPIDController.rst and updates scenarioBranchingPanels to import
from the new module name.
@schaubh schaubh deleted the feature/1366-1367-1368-architecture-changes branch May 1, 2026 02:31
schaubh pushed a commit that referenced this pull request May 1, 2026
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in Basilisk May 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation refactor Clean up with no new functionality

Projects

Status: ✅ Done

3 participants