Logo

Getting Started

  • Installation
    • Install from source
  • About
    • Overview
    • Authors
    • Contributors
    • Acknowledgements

Examples

  • Polynomial Chaos
    • ex_pcbasis1d.py
    • ex_pcrv.py
    • ex_pcrv1.py
    • ex_pcrv2.py
    • ex_pcrv_mvn.py
    • ex_mrv.py
    • ex_mindex.py
    • ex_quad.py
    • ex_uprop.py
    • ex_uprop2.py
  • Regression & Surrogates
    • ex_lreg.py
    • ex_lreg_basiseval.py
    • ex_lreg_merr.py
    • ex_bcs.py (demo)
    • ex_bcs_mindex_growth.py
    • ex_gp.py
    • ex_kl.py
    • ex_klpc.py
  • Bayesian Inference
    • ex_mcmc_banana.py
    • ex_mcmc_fitline.py
    • ex_mcmc_fitmodel.py
    • ex_mfvi.py
    • ex_minf.py
    • ex_minf_sketch.py (demo)
    • ex_evidence.py
  • Sensitivity Analysis
    • ex_gsa.py
    • ex_gsa_multi.py
    • ex_pcgsa.py
  • Rosenblatt Transformation
    • ex_ros.py
    • ex_iros_1d.py
    • ex_iros_2d.py
    • ex_ros_pc.py
    • ex_ros_pcj.py
    • ex_ros_pcs.py
    • ex_rospc_multiple.py
  • Random Variables
    • ex_gmm.py
    • ex_sampling.py
    • ex_mixture.py
    • ex_webull.py
    • ex_mcmcrv.py
  • Functions & Optimization
    • ex_func.py
    • ex_funcall.py
    • ex_funcgrad.py
    • ex_genz1d.py
    • ex_optim.py
    • ex_integrate.py
    • ex_orf.py
  • Plotting
    • ex_colors.py
    • ex_plot_fcn.py
    • ex_slice.py

Apps

  • Polynomial Chaos
    • pc_fit.py
    • pc_prep.py
    • pc_sam.py
  • Multioutput Fits
    • kl_fit.py
    • klsurr_fit.py
    • nn_fit.py
  • Plotting Apps
    • plot_cov.py
    • plot_ens.py
    • plot_pcoord.py
    • plot_pdfs.py
    • plot_xx.py
    • plot_yx.py
    • plot_yxx.py
  • Forward UQ
    • Workflow overview
    • uq_pc.py
    • model.x
    • plot.py
    • workflow_uqpc.x
  • Inverse UQ
    • Workflow overview
    • Prerequisites
    • create_data_truepc.py
    • prep_data.x
    • run_infer.py
    • postp_infer.py
    • workflow_iuq.x
  • Other Apps
    • create_data.py
    • mrun.py
  • Shell Utilities
    • getrange.x
    • scale.x
    • transpose.x

Tutorials

  • Software Tutorials
    • Surrogates
      • Polynomial Chaos Expansion Construction
        • Setup
        • Generate data
      • Residual Neural Network Construction
      • Function Approximation with Sparse Regression
        • Constructing PC surrogate and generating data
        • Least Squares Regression
        • BCS with default settings (default eta)
        • BCS with optimal eta (found through cross-validation)

List of Modules

  • fit
    • fit
      • Classes
      • Module Contents
        • fitbase
    • gp
      • Classes
      • Functions
      • Module Contents
        • kernel_rbf()
        • kernel_sin()
        • gp
  • ftools
    • integr
      • Classes
      • Module Contents
        • Integrator
        • IntegratorScipy
        • IntegratorMCMC
        • IntegratorMC
        • IntegratorWMC
        • IntegratorGMM
        • IntegratorGMMT
    • orf
      • Classes
      • Module Contents
        • GLMAP
        • HMAT
        • MGSV
        • MGS
        • MMGS
        • QR
  • func
    • bench
      • Classes
      • Module Contents
        • Ishigami
        • Wolfe
        • Colville
        • MieleCantrell
        • Powell
        • Dolan
        • Friedman
        • GramacyLee
    • bench1d
      • Classes
      • Module Contents
        • TFData
        • SineSum
        • SineSum2
        • QuadxExp
        • LinxSin
        • SinexExp
        • SineLogSum
        • CosineSum
        • Sinex
        • CosineSum2
        • Sinusoidal
        • Forrester
        • GramacyLee2
        • Higdon
        • Holsclaw
        • DampedCosine
    • bench2d
      • Classes
      • Module Contents
        • Adjiman
        • BartelsConn
        • Bird
        • Branin
        • Branin01
        • Branin02
        • Brent
        • Bukin02
        • Bukin04
        • Bukin6
        • CarromTable
        • ChengSandu
        • Chichinadze
        • CrossInTray
        • Damavandi
        • DeckkersAarts
        • EggCrate
        • EggHolder
        • ElAttarVidyasagarDutta
        • FreudensteinRoth
        • Franke
        • GoldsteinPrice
        • HimmelBlau
        • Hosaki
        • Keane
        • Leon
        • Levy13
        • Lim
        • Matyas
        • Mishra03
        • Mishra04
        • Mishra05
        • Mishra06
        • McCormick
        • NewFunction03
        • Parsopoulos
        • Price01
        • Price02
        • Price03
        • Price04
        • Quadratic
        • Quadratic2d
        • RosenbrockModified
        • RotatedEllipse01
        • RotatedEllipse02
        • Schaffer01
        • Schaffer02
        • Schaffer04
        • Schwefel36
        • SixHumpCamel
        • ThreeHumpCamel
        • Treccani
        • Trefethen
        • Ursem01
        • Ursem03
        • Ursem04
        • UrsemWaves
        • VenterSobiezcczanskiSobieski
        • WayburnSeader01
        • WayburnSeader02
        • Zettl
        • Zirilli
        • DropWave
    • benchNd
      • Classes
      • Module Contents
        • Ackley
        • Alpine01
        • Alpine02
        • AMGM
        • Bohachevsky
        • Cigar
        • CosineMixture
        • Griewank
        • Mishra07
        • MVN
        • NegAlpineN2
        • Sobol
        • SumSquares
    • chem
      • Classes
      • Module Contents
        • LennardJones
        • MullerBrown
    • func
      • Classes
      • Module Contents
        • Function
        • AddFcn
        • SubFcn
        • MultFcn
        • DivFcn
        • PowFcn
        • ModelWrapperFcn
    • genz
      • Classes
      • Module Contents
        • GenzBase
        • GenzOscillatory
        • GenzQuadOscillatory
        • GenzSum
        • GenzCornerPeak
    • oper
      • Classes
      • Module Contents
        • CartesProdFcn
        • GradFcn
        • ComposeFcn
        • SliceFcn
        • ShiftFcn
        • LinTransformFcn
        • PickDim
    • poly
      • Classes
      • Module Contents
        • PolyBase
        • Leg
        • Mon
    • toy
      • Classes
      • Module Contents
        • Constant
        • Identity
        • Quad
        • Quad2d
        • Exp
        • Log
  • gsa
    • gsa
      • Classes
      • Functions
      • Module Contents
        • model_sens()
        • SensMethod
        • Linreg
        • Moat
        • SamSobol
        • PCSobol
  • linred
    • kle
      • Classes
      • Module Contents
        • KLE
    • klnn
      • Classes
      • Module Contents
        • KLNN
    • klsurr
      • Classes
      • Module Contents
        • KLSurr
    • linred
      • Classes
      • Module Contents
        • LinRed
    • svd
      • Classes
      • Module Contents
        • SVD
  • lreg
    • anl
      • Classes
      • Module Contents
        • anl
    • bcs
      • Classes
      • Functions
      • Module Contents
        • bcs
        • bcs_fit()
    • lreg
      • Classes
      • Module Contents
        • lreg
        • lsq
    • merr
      • Classes
      • Functions
      • Module Contents
        • map_flat_to_tri()
        • logpost_emb()
        • lreg_merr
    • opt
      • Classes
      • Functions
      • Module Contents
        • distance()
        • distance_grad()
        • opt
  • minf
    • calib
      • Classes
      • Module Contents
        • MCMCBase
    • infer
      • Classes
      • Module Contents
        • Infer
    • likelihoods
      • Classes
      • Module Contents
        • Likelihood
        • Likelihood_dummy
        • Likelihood_classical
        • Likelihood_logclassical
        • Likelihood_abc
        • Likelihood_gausmarg
    • mcmc
      • Classes
      • Module Contents
        • AMCMC
        • HMC
        • MALA
    • minf
      • Functions
      • Module Contents
        • model_infer()
        • model_infer_postp()
        • plot_1d_data()
        • plot_1d_samples()
        • plot_1dfit()
        • plot_1dfit_vars()
        • plot_1dfit_shade()
        • plot_ndfit_vars()
    • priors
      • Classes
      • Module Contents
        • Prior
        • Prior_uniform
        • Prior_normal
    • vi
      • Classes
      • Module Contents
        • MFVI
  • optim
    • gd
      • Classes
      • Module Contents
        • GD
        • SGD
        • Adam
    • optim
      • Classes
      • Module Contents
        • OptBase
    • pso
      • Classes
      • Module Contents
        • PSO
    • sciwrap
      • Classes
      • Module Contents
        • ScipyWrapper
  • rv
    • mrv
      • Classes
      • Module Contents
        • MRV
        • GMM
        • Mixture
        • Inverse
        • Pareto_1d
        • Normal_1d
        • Lognormal_1d
        • Weibull_1d
        • MCMCRV
    • pcrv
      • Classes
      • Module Contents
        • PCRV
        • PCRV_iid
        • PCRV_mvn
        • PC1d
    • rosen
      • Classes
      • Module Contents
        • Rosenblatt
  • surrogates
    • nn
      • Classes
      • Module Contents
        • NN
    • pce
      • Classes
      • Module Contents
        • PCE
  • utils
    • decors
      • Functions
      • Module Contents
        • timer()
        • show_start_end()
        • repeat()
    • funcbank
      • Functions
      • Module Contents
        • sin4()
        • const()
        • f2d()
        • cosine()
        • sinsum()
        • prodabs()
    • maps
      • Classes
      • Functions
      • Module Contents
        • scale01ToDom()
        • scaleDomTo01()
        • scaleTo01()
        • standardize()
        • XMap
        • Expon
        • Logar
        • ComposeMap
        • LinearScaler
        • Standardizer
        • Normalizer
        • Domainizer
        • Affine
    • metrics
      • Functions
      • Module Contents
        • rel_l2()
        • rmse()
        • rel_rmse()
        • norm_rmse()
        • fast_auc()
        • mae()
        • crps_gauss()
        • crps_samples()
    • mindex
      • Functions
      • Module Contents
        • get_npc()
        • get_mi()
        • encode_mindex()
        • micf_join()
        • mi_addfront_cons()
        • mi_addfront()
    • plotting
      • Functions
      • Module Contents
        • myrc()
        • saveplot()
        • set_colors()
        • lighten_color()
        • plot_dm()
        • plot_xrv()
        • parallel_coordinates()
        • plot_yx()
        • plot_sens()
        • plot_jsens()
        • plot_tri()
        • plot_pdf1d()
        • plot_pdf2d()
        • plot_pdfs()
        • plot_ens()
        • plot_vars()
        • plot_shade()
        • plot_1d_anchored_single()
        • plot_1d_anchored()
        • plot_2d_anchored_single()
        • plot_2d_anchored()
        • plot_fcn_1d_slice()
        • plot_fcn_2d_slice()
        • plot_uc_sample()
        • plot_uc_exact()
        • plot_samples_pdfs()
        • plot_1d()
        • plot_2d()
        • plot_parity()
        • plot_cov()
        • plot_cov_tri()
        • plot_sensmat()
        • plot_joy()
    • stats
      • Functions
      • Module Contents
        • get_stats()
        • get_domain()
        • intersect_domain()
        • diam()
    • uqtk_utils
      • Functions
      • Module Contents
        • pce_eval()
        • pce_sens()
        • get_pdf_uqtk()
    • xutils
      • Functions
      • Module Contents
        • idt()
        • savepk()
        • loadpk()
        • cartes_list()
        • read_textlist()
        • sample_sphere()
        • get_opt_bw()
        • get_pdf()
        • strarr()
        • project()
        • pick_basis()
        • safe_cholesky()
        • instantiate_classes_from_module()
  • workflows
    • fits
      • Functions
      • Module Contents
        • pc_fit()
        • pc_ros()
    • uprop
      • Functions
      • Module Contents
        • uprop_proj()
        • uprop_regr()

Misc

  • Index
  • References
  • Class Inheritance Diagrams
    • Fitting
    • Linear Regression
    • MCMC Samplers
    • Priors
    • Likelihoods
    • Random Variables
    • Functions
    • Global Sensitivity Analysis
    • Linear Dimensionality Reduction
    • Optimisers
PyTUQ
  • Overview: module code

All modules for which code is available

  • pytuq.fit.fit
  • pytuq.fit.gp
  • pytuq.ftools.integr
  • pytuq.ftools.orf
  • pytuq.func.bench
  • pytuq.func.bench1d
  • pytuq.func.bench2d
  • pytuq.func.benchNd
  • pytuq.func.chem
  • pytuq.func.func
  • pytuq.func.genz
  • pytuq.func.oper
  • pytuq.func.poly
  • pytuq.func.toy
  • pytuq.gsa.gsa
  • pytuq.linred.kle
  • pytuq.linred.klnn
  • pytuq.linred.klsurr
  • pytuq.linred.linred
  • pytuq.linred.svd
  • pytuq.lreg.anl
  • pytuq.lreg.bcs
  • pytuq.lreg.lreg
  • pytuq.lreg.merr
  • pytuq.lreg.opt
  • pytuq.minf.calib
  • pytuq.minf.infer
  • pytuq.minf.likelihoods
  • pytuq.minf.mcmc
  • pytuq.minf.minf
  • pytuq.minf.priors
  • pytuq.minf.vi
  • pytuq.optim.gd
  • pytuq.optim.optim
  • pytuq.optim.pso
  • pytuq.optim.sciwrap
  • pytuq.rv.mrv
  • pytuq.rv.pcrv
  • pytuq.rv.rosen
  • pytuq.surrogates.nn
  • pytuq.surrogates.pce
  • pytuq.utils.decors
  • pytuq.utils.funcbank
  • pytuq.utils.maps
  • pytuq.utils.metrics
  • pytuq.utils.mindex
  • pytuq.utils.plotting
  • pytuq.utils.stats
  • pytuq.utils.uqtk_utils
  • pytuq.utils.xutils
  • pytuq.workflows.fits
  • pytuq.workflows.uprop

© Copyright 2025, Bert Debusschere, Khachik Sargsyan, Emilie Baillo.

Built with Sphinx using a theme provided by Read the Docs.