SALib

Sobol' bug fixes and documentation updates

What's Changed

• Fix log2 in Sobol' exponent check by @tupui in https://github.com/SALib/SALib/pull/546
• WIP: Documentation fixes for Sphinx and website by @ConnectedSystems in https://github.com/SALib/SALib/pull/540
• Changes to address test deprecation warnings by @ConnectedSystems in https://github.com/SALib/SALib/pull/548

Full Changelog: https://github.com/SALib/SALib/compare/v1.4.6.1...v1.4.7

Quick release with fix to allow 0 skipping of sobol' sequence.

What's Changed

• Fix skip_values integer check by @tupui in https://github.com/SALib/SALib/pull/542

Full Changelog: https://github.com/SALib/SALib/compare/v1.4.6...v1.4.6.1

Highlights

• Performance improvements to HDMR (~50% decrease in runtime for the Ishigami function)
• New Sobol' sampler (interfaced with SciPy) which supports sequence scrambling
• New heatmap visualization
• Improvements to documentation for Morris, PAWN and HDMR methods.
• New documentation website, thanks to @tupui and @sahin-abdullah

What's Changed

• Support additional positional arguments when using parallel evaluators/analyses by @ConnectedSystems in https://github.com/SALib/SALib/pull/473
• Add Oakley 2004 test function (Resolve #379) by @ConnectedSystems in https://github.com/SALib/SALib/pull/474
• Update example results in document by @ConnectedSystems in https://github.com/SALib/SALib/pull/477
• Docs: correct plural. by @brenthuisman in https://github.com/SALib/SALib/pull/476
• Improve listing of compatible sampling methods by @ConnectedSystems in https://github.com/SALib/SALib/pull/482
• Updated Sobol' direction numbers by @ConnectedSystems in https://github.com/SALib/SALib/pull/491
• Update hdmr.py by @idiomaticrefactoring in https://github.com/SALib/SALib/pull/496
• Raise error when a single parameter/group is detected [OO-based only] by @ConnectedSystems in https://github.com/SALib/SALib/pull/484
• Fix for #480 - eFAST analysis erroring by @ConnectedSystems in https://github.com/SALib/SALib/pull/481
• add GitHub URL for PyPi by @andriyor in https://github.com/SALib/SALib/pull/502
• Expanded Morris docs by @ConnectedSystems in https://github.com/SALib/SALib/pull/489
• Expanded docs for the PAWN method by @ConnectedSystems in https://github.com/SALib/SALib/pull/490
• Better Triangular Distribution by @BrandonSLockey in https://github.com/SALib/SALib/pull/509
• Add missing parameters to docstrings by @schmitts in https://github.com/SALib/SALib/pull/434
• Support for grouped parameters with the PAWN method by @ConnectedSystems in https://github.com/SALib/SALib/pull/512
• Migrate to hatchling and migrate CI to GitHub actions by @tupui in https://github.com/SALib/SALib/pull/527
• Make Pathos optional by @tupui in https://github.com/SALib/SALib/pull/522
• Add Sobol' sampler from SciPy by @tupui in https://github.com/SALib/SALib/pull/519
• Allow seed as CLI option by @ConnectedSystems in https://github.com/SALib/SALib/pull/530
• Use pydata-sphinx-theme by @tupui in https://github.com/SALib/SALib/pull/523
• Update version switcher by @tupui in https://github.com/SALib/SALib/pull/533
• Sobol': Handle zero variance edge case by @ConnectedSystems in https://github.com/SALib/SALib/pull/505
• Heatmap by @ConnectedSystems in https://github.com/SALib/SALib/pull/526
• Handle DMIM zero variance case by @ConnectedSystems in https://github.com/SALib/SALib/pull/536
• HDMR Performance improvements by @ConnectedSystems in https://github.com/SALib/SALib/pull/511
• HDMR Docstring by @sahin-abdullah in https://github.com/SALib/SALib/pull/538
• Triang dist bounds fix by @ConnectedSystems in https://github.com/SALib/SALib/pull/537
• Pre-release documentation updates by @ConnectedSystems in https://github.com/SALib/SALib/pull/539

New Contributors

• @brenthuisman made their first contribution in https://github.com/SALib/SALib/pull/476
• @idiomaticrefactoring made their first contribution in https://github.com/SALib/SALib/pull/496
• @andriyor made their first contribution in https://github.com/SALib/SALib/pull/502
• @BrandonSLockey made their first contribution in https://github.com/SALib/SALib/pull/509
• @tupui made their first contribution in https://github.com/SALib/SALib/pull/527

Full Changelog: https://github.com/SALib/SALib/compare/v1.4.5...v1.4.6

v1.4.6 Release Candidate.

A full release will be done if no issues are encountered.

What's Changed

• Support additional positional arguments when using parallel evaluators/analyses by @ConnectedSystems in https://github.com/SALib/SALib/pull/473
• Add Oakley 2004 test function (Resolve #379) by @ConnectedSystems in https://github.com/SALib/SALib/pull/474
• Update example results in document by @ConnectedSystems in https://github.com/SALib/SALib/pull/477
• Docs: correct plural. by @brenthuisman in https://github.com/SALib/SALib/pull/476
• Improve listing of compatible sampling methods by @ConnectedSystems in https://github.com/SALib/SALib/pull/482
• Updated Sobol' direction numbers by @ConnectedSystems in https://github.com/SALib/SALib/pull/491
• Update hdmr.py by @idiomaticrefactoring in https://github.com/SALib/SALib/pull/496
• Raise error when a single parameter/group is detected [OO-based only] by @ConnectedSystems in https://github.com/SALib/SALib/pull/484
• Fix for #480 - eFAST analysis erroring by @ConnectedSystems in https://github.com/SALib/SALib/pull/481
• add GitHub URL for PyPi by @andriyor in https://github.com/SALib/SALib/pull/502
• Expanded Morris docs by @ConnectedSystems in https://github.com/SALib/SALib/pull/489
• Expanded docs for the PAWN method by @ConnectedSystems in https://github.com/SALib/SALib/pull/490
• Better Triangular Distribution by @BrandonSLockey in https://github.com/SALib/SALib/pull/509
• Add missing parameters to docstrings by @schmitts in https://github.com/SALib/SALib/pull/434
• Support for grouped parameters with the PAWN method by @ConnectedSystems in https://github.com/SALib/SALib/pull/512
• Migrate to hatchling and migrate CI to GitHub actions by @tupui in https://github.com/SALib/SALib/pull/527
• Make Pathos optional by @tupui in https://github.com/SALib/SALib/pull/522
• Add Sobol' sampler from SciPy by @tupui in https://github.com/SALib/SALib/pull/519
• Allow seed as CLI option by @ConnectedSystems in https://github.com/SALib/SALib/pull/530
• Use pydata-sphinx-theme by @tupui in https://github.com/SALib/SALib/pull/523
• Update version switcher by @tupui in https://github.com/SALib/SALib/pull/533
• Sobol': Handle zero variance edge case by @ConnectedSystems in https://github.com/SALib/SALib/pull/505
• Heatmap by @ConnectedSystems in https://github.com/SALib/SALib/pull/526
• Handle DMIM zero variance case by @ConnectedSystems in https://github.com/SALib/SALib/pull/536
• HDMR Performance improvements by @ConnectedSystems in https://github.com/SALib/SALib/pull/511
• HDMR Docstring by @sahin-abdullah in https://github.com/SALib/SALib/pull/538
• Triang dist bounds fix by @ConnectedSystems in https://github.com/SALib/SALib/pull/537

New Contributors

• @brenthuisman made their first contribution in https://github.com/SALib/SALib/pull/476
• @idiomaticrefactoring made their first contribution in https://github.com/SALib/SALib/pull/496
• @andriyor made their first contribution in https://github.com/SALib/SALib/pull/502
• @BrandonSLockey made their first contribution in https://github.com/SALib/SALib/pull/509
• @tupui made their first contribution in https://github.com/SALib/SALib/pull/527

Full Changelog: https://github.com/SALib/SALib/compare/v1.4.5...v1.4.6-rc

Second beta release of v1.4.6

What's Changed

• Expanded Morris docs by @ConnectedSystems in https://github.com/SALib/SALib/pull/489
• Expanded docs for the PAWN method by @ConnectedSystems in https://github.com/SALib/SALib/pull/490
• Better Triangular Distribution by @BrandonSLockey in https://github.com/SALib/SALib/pull/509

New Contributors

• @BrandonSLockey made their first contribution in https://github.com/SALib/SALib/pull/509

Full Changelog: https://github.com/SALib/SALib/compare/v1.4.6-beta.0...v1.4.6-beta.1

What's Changed

• Support additional positional arguments when using parallel evaluators/analyses by @ConnectedSystems in https://github.com/SALib/SALib/pull/473
• Add Oakley 2004 test function (Resolve #379) by @ConnectedSystems in https://github.com/SALib/SALib/pull/474
• Update example results in document by @ConnectedSystems in https://github.com/SALib/SALib/pull/477
• Docs: correct plural. by @brenthuisman in https://github.com/SALib/SALib/pull/476
• Improve listing of compatible sampling methods by @ConnectedSystems in https://github.com/SALib/SALib/pull/482
• Updated Sobol' direction numbers by @ConnectedSystems with help from @Xifus in https://github.com/SALib/SALib/pull/491
• Update hdmr.py by @zjzh in https://github.com/SALib/SALib/pull/496
• Raise error when a single parameter/group is detected [OO-based only] by @ConnectedSystems in https://github.com/SALib/SALib/pull/484
• Fix for #480 - eFAST analysis erroring by @ConnectedSystems in https://github.com/SALib/SALib/pull/481

New Contributors

• @brenthuisman made their first contribution in https://github.com/SALib/SALib/pull/476
• @zjzh made their first contribution in https://github.com/SALib/SALib/pull/496

Full Changelog: https://github.com/SALib/SALib/compare/v1.4.5...v1.4.6-beta.0

• Adjusted Saltelli sampling to follow recommendation of Owen (2020)
  (http://arxiv.org/abs/2008.08051; https://github.com/scipy/scipy/pull/10844#issuecomment-672186615)
• Initial support for parallel analysis
• Updated Sobol' G-function analytic results (PR #464, Issues #335 #461)
• Sobol' analysis: Optional storage of intermediate resample results to allow analysis of variation (PR #462)

Documentation

• Updated Salteli sampling examples to use powers of 2 following recommendations
• Added citations.cff file

Development

• Upgrade PyScaffold to v4
• Replaced recommonmark with MyST (PR #466)

Minor update to allow no skip values in Saltelli/Sobol' sampling (#443)

See: https://github.com/SALib/SALib/issues/442 for context

Hotfix to address wheel dependency when installing SALib with venv

• Many documentation improvements
• Explicitly mention extended FAST in documentation
• Saltelli sampling: Warnings displayed when selected samples do not meet
  requirements (PR #416).
• Conversion to DataFrame when groups are defined with Sobol' results
  (PR #413 and Issue #387)
• Group sampling and analysis enabled for Sobol' and morris
• Enhanced DataFrame support for groups

v1.4.0 Release

Shortlist of changes since v1.3.x

Added

• High Dimensional Model Representation (HDMR) method (PR #275)
• PAWN method (PR #415)
• Support for sampling/analysis method chaining (PR #339)
• Support for truncated normal distribution (PR #383)
• Confidence Interval estimation for FAST-based methods (PR #375)
• Initial support for parallel model evaluation

Documentation

• Defining non-uniform sampling now explicitly documented
• Many general documentation improvements
• Added FAQ

Development

• Generalized support for non-uniform sampling methods (PR #346)

Documentation Hotfix: Address broken link in documentation for RBD-FAST (thanks @Vaibhavdixit02)

This pre-release includes a fix that prevented method chaining from working correctly.

• Improved documentation
• Continued improvements to method chaining approach
• HDMR method (thanks to @sahin-abdullah)
• Better plotting support
• Confidence interval estimation for FAST and RBD-FAST

• HDMR method
• New ProblemSpec class
• Method chaining approach
• Better plotting support
• Unified print_to_console output (with the exception of HDMR results)
• Improved documentation
• Initial FAQ added

• Basic sensitivity index plotting (bar plot)
• Clean duplicate options
• Bugfixes

bugfixes

Update testing framework and small bug fixes

Major changes:

• Consolidated command-line interface (refer to new scripts in examples/ directory)
• Ability to convert results to pandas dataframe
  (thanks to @ConnectedSystems for these updates)

In addition to several small bugfixes.