romcomma.user.run.gsa§

gsa(name, repo, is_covariant, is_isotropic, kinds=[Kind.FIRST_ORDER, Kind.CLOSED, Kind.TOTAL], m=-1, ignore_exceptions=False, is_error_calculated=False, **kwargs)[source]§

Undertake GSA on a Fold, or recursively across the Folds in a Repository.

Parameters:

  • name (str) – The GSA name.

  • repo (Repository) – A Fold to house the GSA, or a Repository containing Folds to house the GSAs.

  • is_covariant (bool | None) – Whether each output is independent of the other outputs. None results in variant (independent) followed by covariant (dependent).

  • is_isotropic (bool | None) – Whether the kernel is isotropic. If None, isotropic is run, then broadcast to run anisotropic.

  • kinds (Kind | Sequence[Kind]) – Kind of index to calculate - first_order, closed or total. A Sequence of Kinds will be run consecutively.

  • is_error_calculated (bool) – Whether to calculate variances (errors) on the Sobol indices. The calculation of error is memory intensive, so leave this flag as False unless you are sure you need errors. Furthermore, errors will only be calculated if the kernel of the GP has diagonal variance F.

  • m (int) – The dimensionality of the reduced model. For a single calculation it is required that 0 < m < gp.M. Any m outside this range results the Sobol index of each kind being calculated for all m in range(1, M+1).

  • ignore_exceptions (bool) – Whether to ignore exceptions (e.g. file not found) when they are encountered, or halt.

  • kwargs – A Dict of gsa calculation options, which updates the default gsa.undertake.calculation.META.

Raises:

FileNotFoundError – If repo is not a Fold, and contains no Folds.

Returns:

A list of the calculation names which have been run, relative to repo.folder.

Return type:

List[Path]