damar-wicaksono / uqtestfuns

A Python3 library of test functions from the uncertainty quantification community with a common interface for validation and benchmarking purposes.
https://uqtestfuns.readthedocs.io/en/latest/
MIT License
8 stars 0 forks source link

Add a helper function to show all the available test functions #46

Closed damar-wicaksono closed 1 year ago

damar-wicaksono commented 1 year ago

The function when called should print to the terminal the available test functions: the name, the string code, and the number of spatial dimensions; preferably in tabular format.

damar-wicaksono commented 1 year ago

This issue has been resolved by PR #117.

A high-level function now exists to list all the available UQ test functions with a basic filtering ability based on spatial dimension and application tag:

>>> import uqtestfuns as uqtf

>>> uqtf.list_functions()
 No.      Constructor       Spatial Dimension          Application         Description
-----  ------------------  -------------------  -------------------------  ----------------------------------------------------------------------------
  1         Ackley()                M                 optimization         Ackley function from Ackley (1987)
  2        Borehole()               8           metamodeling, sensitivity  Borehole function from Harper and Gupta (1983)
  3    DampedOscillator()           8           metamodeling, sensitivity  Damped oscillator model from Igusa and Der Kiureghian (1985)
  4         Flood()                 8           metamodeling, sensitivity  Flood model from Iooss and Lemaître (2015)
  5        Ishigami()               3           metamodeling, sensitivity  Ishigami function from Ishigami and Homma (1991)
  6       OTLCircuit()              6           metamodeling, sensitivity  Output transformerless (OTL) circuit model from Ben-Ari and Steinberg (2007)
  7         Piston()                7           metamodeling, sensitivity  Piston simulation model from Ben-Ari and Steinberg (2007)
  8         SobolG()                M                  sensitivity         Sobol-G function from Sobol' (1998)
  9         Sulfur()                9           metamodeling, sensitivity  Sulfur model from Charlson et al. (1992)
 10       WingWeight()             10           metamodeling, sensitivity  Wing weight model from Forrester et al. (2008)