Skip to content

Rename Sobol sensitivity method#938

Merged
NicolaCourtier merged 6 commits into
developfrom
rename-sobol-sensitivities
May 14, 2026
Merged

Rename Sobol sensitivity method#938
NicolaCourtier merged 6 commits into
developfrom
rename-sobol-sensitivities

Conversation

@NicolaCourtier
Copy link
Copy Markdown
Member

Description

Add a check for finite bounds and specify the method by renaming sensitivity_analysis to get_sobol_sensitivities.

Fixes #657

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #).

Important checks:

Please confirm the following before marking the PR as ready for review:

  • No style issues: $ pre-commit run or $ nox -s pre-commit (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: nox -s tests
  • The documentation builds: nox -s doctest
  • Code is commented for hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.11%. Comparing base (4628a65) to head (9e62c38).
⚠️ Report is 56 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #938      +/-   ##
===========================================
+ Coverage    89.41%   92.11%   +2.69%     
===========================================
  Files           63       74      +11     
  Lines         4857     5784     +927     
===========================================
+ Hits          4343     5328     +985     
+ Misses         514      456      -58     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@NicolaCourtier
Copy link
Copy Markdown
Member Author

Alternatively, we can deprecate the function and move SALib into the optional dependencies, as SALib is only used directly in the examples. What do you think @Dibyendu-IITKGP ?

Comment thread pybop/analysis/sensitivity_analysis.py Outdated
Copy link
Copy Markdown
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Neat, thanks, I see that this was removed completely! Let's also update this section as well: https://pybop-docs.readthedocs.io/en/latest/installation.html#optional-dependencies

@NicolaCourtier
Copy link
Copy Markdown
Member Author

Thanks @agriyakhetarpal, I've added the more recent optional dependencies to the docs, good spot!

@NicolaCourtier NicolaCourtier merged commit e841f38 into develop May 14, 2026
35 checks passed
@NicolaCourtier NicolaCourtier deleted the rename-sobol-sensitivities branch May 14, 2026 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Global Sensitivities struggle with non-bounded parameters

2 participants