Logo
  • Installation, Testing, & Publishing
    • Basic Installation
    • Installing from Source
    • Running Tests and Type Checking
    • Profiling
    • Building Docs
    • Releasing a New Version and Publishing to PyPI
  • Basic Architecture
  • Basic Workflow
    • Examples
    • Debugging
  • Serial and Parallel Processing
    • Serial Processing (Single-threaded)
      • Configuration
    • Multiprocessing
      • Configuration
      • Start Methods
    • Dask Distributed Computing
      • Configuration
      • Distributed Cloud Compute Clusters
      • Connecting to Existing Clusters
    • Choosing your Processing Approach
  • Statistical Distributions
    • Usage
    • Continuous Distributions
    • Discrete Distributions
  • Sampling Methods
    • Random Sampling Methodology
    • Sampling Methods
    • Best Practices
    • Integration
    • Comparison Plots
    • Further Reading
  • API Reference
    • Classes
      • Sim
        • SimulationFunctions
          • SimulationFunctions.from_dict()
        • Sim
          • Sim.rootdir
          • Sim.filepath
          • Sim.pool
          • Sim.cluster
          • Sim.client
          • Sim.invarseeds
          • Sim.outvarseeds
          • Sim.caseseeds
          • Sim.inittime
          • Sim.starttime
          • Sim.endtime
          • Sim.runtime
          • Sim.casespreprocessed
          • Sim.casesrun
          • Sim.casespostprocessed
          • Sim.vars
          • Sim.invars
          • Sim.outvars
          • Sim.constvals
          • Sim.cases
          • Sim.ninvars
          • Sim.noutvars
          • Sim.corrcoeffs
          • Sim.covs
          • Sim.covvarlist
          • Sim.runsimid
          • Sim.ncases
          • Sim.setFirstCaseMedian()
          • Sim.initDaskClient()
          • Sim.initMultiprocessingPool()
          • Sim.addInVar()
          • Sim.addConstVal()
          • Sim.setNDraws()
          • Sim.drawVars()
          • Sim.runSim()
          • Sim.runIncompleteSim()
          • Sim.runSimWorker()
          • Sim.genRunSimID()
          • Sim.genCases()
          • Sim.genCaseSeeds()
          • Sim.restorePickledCases()
          • Sim.executeAllFcns()
          • Sim.executeFullPipeline()
          • Sim.executeFullPipelineDask()
          • Sim.preProcessCases()
          • Sim.runCases()
          • Sim.postProcessCases()
          • Sim.genOutVars()
          • Sim.scalarOutVars()
          • Sim.extendOutVars()
          • Sim.calcSensitivities()
          • Sim.genCovarianceMatrix()
          • Sim.corr()
          • Sim.cov()
          • Sim.plot()
          • Sim.clearResults()
          • Sim.reset()
          • Sim.exportInVars()
          • Sim.exportOutVars()
          • Sim.importInVars()
          • Sim.importOutVars()
          • Sim.saveSim()
          • Sim.saveCases()
          • Sim.loadSim()
          • Sim.loadCases()
          • Sim.removeExtraResultsFiles()
      • Case
        • Case
          • Case.starttime
          • Case.endtime
          • Case.runtime
          • Case.filepath
          • Case.runsimid
          • Case.haspreprocessed
          • Case.hasrun
          • Case.haspostprocessed
          • Case.constvals
          • Case.invals
          • Case.outvals
          • Case.siminput
          • Case.simrawoutput
          • Case.getInVals()
          • Case.addOutVar()
          • Case.getOutVals()
          • Case.addOutVal()
      • Var
        • Var
          • Var.name
          • Var.ndraws
          • Var.seed
          • Var.firstcaseismedian
          • Var.datasource
          • Var.ncases
          • Var.vals
          • Var.valmap
          • Var.nums
          • Var.nummap
          • Var.pcts
          • Var.maxdim
          • Var.isscalar
          • Var.varstats
          • Var.setFirstCaseMedian()
          • Var.stats()
          • Var.addVarStat()
          • Var.clearVarStats()
          • Var.plot()
        • InVar
          • InVar.isscalar
          • InVar.maxdim
          • InVar.valmap
          • InVar.pcts
          • InVar.nums
          • InVar.vals
          • InVar.varstats
          • InVar.check_pcts()
          • InVar.mapNums()
          • InVar.extractNumMap()
          • InVar.genValMap()
          • InVar.setNDraws()
          • InVar.draw()
          • InVar.getVal()
          • InVar.getDistMedian()
          • InVar.getDistMean()
        • OutVar
          • OutVar.isscalar
          • OutVar.maxdim
          • OutVar.nummap
          • OutVar.nums
          • OutVar.varstats
          • OutVar.genMaxDim()
          • OutVar.extractValMap()
          • OutVar.genNumMap()
          • OutVar.mapVals()
          • OutVar.getVal()
          • OutVar.getMedianVal()
          • OutVar.split()
          • OutVar.plotSensitivities()
      • Val
        • Val
        • InVal
          • InVal.val
          • InVal.isscalar
          • InVal.shape
          • InVal.valmap
          • InVal.mapNum()
          • InVal.genValMap()
        • OutVal
          • OutVal.num
          • OutVal.valmapsource
          • OutVal.isscalar
          • OutVal.shape
          • OutVal.nummap
          • OutVal.convertPandas()
          • OutVal.genShape()
          • OutVal.extractValMap()
          • OutVal.mapVal()
          • OutVal.genNumMap()
          • OutVal.split()
      • VarStat
        • VarStat
          • VarStat.nums
          • VarStat.confidence_interval_low_nums
          • VarStat.confidence_interval_high_nums
          • VarStat.vals
          • VarStat.cases
          • VarStat.ncases
          • VarStat.confidence_interval_low_vals
          • VarStat.confidence_interval_high_vals
          • VarStat.bootstrap_n
          • VarStat.bootstrap_method
          • VarStat.genStatsMoment()
          • VarStat.genStatsPercentile()
          • VarStat.genStatsSigma()
          • VarStat.genStatsGaussianP()
          • VarStat.sigma()
          • VarStat.statsFunctionWrapper()
          • VarStat.genStatsFunction()
          • VarStat.genStatsOrderStatTI()
          • VarStat.genStatsOrderStatP()
          • VarStat.checkOrderStatsKWArgs()
          • VarStat.checkInNummap()
          • VarStat.setName()
      • Enums
        • SampleMethod
          • SampleMethod.RANDOM
          • SampleMethod.SOBOL
          • SampleMethod.SOBOL_RANDOM
          • SampleMethod.HALTON
          • SampleMethod.HALTON_RANDOM
          • SampleMethod.LATIN_HYPERCUBE
        • SimFunctions
          • SimFunctions.PREPROCESS
          • SimFunctions.RUN
          • SimFunctions.POSTPROCESS
        • StatBound
          • StatBound.NEAREST
          • StatBound.BOTH
          • StatBound.ALL
          • StatBound.ONESIDED
          • StatBound.TWOSIDED
          • StatBound.ONESIDED_UPPER
          • StatBound.ONESIDED_LOWER
        • VarStatType
          • VarStatType.MAX
          • VarStatType.MIN
          • VarStatType.MEDIAN
          • VarStatType.MEAN
          • VarStatType.GEOMEAN
          • VarStatType.MODE
          • VarStatType.VARIANCE
          • VarStatType.SKEWNESS
          • VarStatType.KURTOSIS
          • VarStatType.MOMENT
          • VarStatType.PERCENTILE
          • VarStatType.SIGMA
          • VarStatType.GAUSSIANP
          • VarStatType.ORDERSTATTI
          • VarStatType.ORDERSTATP
        • VarStatSide
          • VarStatSide.HIGH
          • VarStatSide.LOW
          • VarStatSide.BOTH
          • VarStatSide.ALL
        • PlotOrientation
          • PlotOrientation.VERTICAL
          • PlotOrientation.HORIZONTAL
        • InVarSpace
          • InVarSpace.NUMS
          • InVarSpace.PCTS
        • Sensitivities
          • Sensitivities.INDICES
          • Sensitivities.RATIOS
    • Functions
      • helper_functions
        • next_power_of_2()
        • hash_str_repeatable()
        • hashable_val_vectorized()
        • hashable_val()
        • is_num()
        • length()
        • get_list()
        • get_cases()
        • slice_by_index()
        • configure_logging()
        • log_to_file()
        • warn_short_format()
        • vwarn()
        • vwrite()
        • timeit()
        • empty_list()
        • flatten()
      • sampling
        • sampling()
        • cached_pcts()
      • plot
        • plot()
        • plot_hist()
        • plot_cdf()
        • plot_2d_scatter()
        • plot_2d_line()
        • plot_3d_scatter()
        • plot_2p5d_line()
        • plot_3d_line()
        • plot_cov_corr()
        • plot_integration_convergence()
        • plot_integration_error()
        • plot_sensitivities()
        • manage_axis()
        • apply_category_labels()
        • get_hist_lim()
        • plot_rug_marks()
        • plot_2d_cov_ellipse()
        • manage_invar_space()
        • get_plot_points()
        • get_var_steps()
      • multi_plot
        • multi_plot()
        • multi_plot_2d_scatter_hist()
        • multi_plot_grid_tri()
        • multi_plot_grid_rect()
        • handle_fig()
      • gaussian_statistics
        • pct2sig()
        • sig2pct()
        • conf_ellipsoid_pct2sig()
        • conf_ellipsoid_sig2pct()
      • order_statistics
        • order_stat_TI_n()
        • order_stat_TI_p()
        • order_stat_TI_k()
        • order_stat_TI_c()
        • order_stat_P_n()
        • order_stat_P_k()
        • order_stat_P_c()
        • EPYP()
        • EPTI()
        • get_iP()
        • order_stat_var_check()
      • integration_statistics
        • integration_error()
        • integration_n_from_err()
        • integration_args_check()
        • max_variance()
        • max_stdev()
monaco
  • Search

© Copyright 2025, Scott Shambaugh.

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