Mga

[samgdotson]

Summary of changes

This PR adds a feature to run an n-dimensional modeling-to-generate-alternatives algorithm called n_mga.
The feature is robustly tested and documented. This is the final "big piece" of osier! Additionally, its adoption will make osier ready for a new minor release! Woohoo!

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• I have read the CONTRIBUTING document. (Yes, the one that I wrote 😉)
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

Associated Issues and PRs

• Issue:
  Closes Add an MGA module to osier #46

Checklist for Reviewers

Reviewers should use this link to get to the
Review Checklist before they begin their review.

[pep8speaks]

Hello @samgdotson! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file osier/utils.py:

Line 30:80: E501 line too long (80 > 79 characters)
Line 251:80: E501 line too long (80 > 79 characters)
Line 254:80: E501 line too long (80 > 79 characters)
Line 258:59: W291 trailing whitespace
Line 267:40: E231 missing whitespace after ','
Line 384:80: E501 line too long (91 > 79 characters)
Line 476:80: E501 line too long (80 > 79 characters)
Line 487:80: E501 line too long (82 > 79 characters)
Line 492:80: E501 line too long (96 > 79 characters)
Line 506:80: E501 line too long (80 > 79 characters)
Line 519:80: E501 line too long (99 > 79 characters)
Line 521:80: E501 line too long (128 > 79 characters)
Line 540:80: E501 line too long (80 > 79 characters)
Line 559:33: E231 missing whitespace after ','
Line 578:80: E501 line too long (83 > 79 characters)
Line 580:80: E501 line too long (83 > 79 characters)

• In the file tests/test_utils.py:

Line 83:80: E501 line too long (80 > 79 characters)

Comment last updated at 2025-01-17 22:18:48 UTC

[LukeSeifert]

Looks good! I had some suggestions in a couple places, also I think maybe some extra text in the mga_tutorial describing what is happening and what the plots are showing would be helpful

[samgdotson]

Thanks @LukeSeifert. I adopted many of your suggestions. I'd prefer to leave the tutorial as-is for now. Let me know if this is blocking for you, though.

[LukeSeifert]

Looks good! Let me know if you would like for me to merge or if you'd prefer to wait for more reviews

[samgdotson]

@LukeSeifert you can go ahead and merge!