ResourceMap

class ResourceMap(*args, **kwargs)

The ResourceMap allows to manage constants that are associated to key strings.

Find below the ResourceMap’s content:

Key Value
ARMA-MeanEpsilon 1e-14
ARMALikelihoodFactory-DefaultMaxFun 10000
ARMALikelihoodFactory-DefaultRhoBeg 0.01
ARMALikelihoodFactory-DefaultRhoEnd 1e-10
ARMALikelihoodFactory-DefaultStartingPointScale 1
ARMALikelihoodFactory-MaximalScaling 100000
ARMALikelihoodFactory-RootEpsilon 1e-06
ARMALikelihoodFactory-StartingScaling 1e-13
AbdoRackwitz-DefaultOmega 0.0001
AbdoRackwitz-DefaultSmooth 1.2
AbdoRackwitz-DefaultTau 0.5
AbsoluteExponential-DefaultTheta 1
AdaptiveDirectionalSampling-DefaultGamma 0.5
AdaptiveDirectionalSampling-DefaultMaximumStratificationDimension 3
AdaptiveDirectionalSampling-DefaultNumberOfSteps 2
AdaptiveStieltjesAlgorithm-MaximumError 1e-12
AdaptiveStieltjesAlgorithm-MaximumSubIntervalsBetweenRoots 64
AliMikhailHaqCopulaFactory-ThetaEpsilon 1e-14
AnalyticalResult-DefaultWidth 1
BernsteinCopulaFactory-Parallel false
BlendedStep-DefaultEta 1
BoxCoxFactory-DefaultMaxFun 2000
BoxCoxFactory-DefaultPointNumber 201
BoxCoxFactory-DefaultRhoBeg 0.1
BoxCoxFactory-DefaultRhoEnd 1e-10
BurrFactory-AbsolutePrecision 1e-12
BurrFactory-MaximumIteration 10
BurrFactory-RelativePrecision 1e-12
BurrFactory-ResidualPrecision 1e-12
CalibrationStrategy-DefaultCalibrationStep 100
CalibrationStrategy-DefaultExpansionFactor 1.2
CalibrationStrategy-DefaultLowerBound 0.117
CalibrationStrategy-DefaultShrinkFactor 0.8
CalibrationStrategy-DefaultUpperBound 0.468
CenteredFiniteDifferenceGradient-DefaultEpsilon 1e-05
CenteredFiniteDifferenceHessian-DefaultEpsilon 0.0001
CholeskyMethod-LargeCase 128
Classifier-Parallel true
CleaningStrategy-DefaultMaximumSize 20
CleaningStrategy-DefaultSignificanceFactor 0.0001
Cobyla-DefaultRhoBeg 0.1
Collection-size-visible-in-str-from 10
Compact-DefaultHalfMaximumSize 1024
ComplexTensor-size-visible-in-str-from 6
CompositeDistribution-SolverEpsilon 1e-10
CompositeDistribution-StepNumber 256
ConditionalDistribution-MarginalIntegrationNodesNumber 256
ConditionalDistribution-MaximumIntegrationNodesNumber 100000
ContinuousDistribution-DefaultIntegrationNodesNumber 256
Contour-DefaultLevelsNumber 10
CovarianceModel-DefaultNuggetFactor 1e-12
DesignProxy-DefaultCacheSize 16777216
Dirichlet-DefaultIntegrationSize 50
Dirichlet-DefaultSamplingSize 500000
DirichletFactory-MaximumIteration 10
DirichletFactory-ParametersEpsilon 1e-12
DiscreteDistribution-SupportEpsilon 1e-14
DistFunc-MaximumIteration 5000
DistFunc-Precision 1e-14
Distribution-CharacteristicFunctionBlockMax 20
Distribution-CharacteristicFunctionNMax 1000000
Distribution-DefaultCDFEpsilon 1e-14
Distribution-DefaultIntegrationNodesNumber 255
Distribution-DefaultLevelNumber 10
Distribution-DefaultPDFEpsilon 1e-14
Distribution-DefaultPointNumber 129
Distribution-DefaultQuantileCacheSize 128
Distribution-DefaultQuantileEpsilon 1e-12
Distribution-DefaultQuantileIteration 100
Distribution-MinimumVolumeLevelSetBySampling false
Distribution-MinimumVolumeLevelSetSamplingSize 1000000
Distribution-Parallel true
Distribution-QMax 0.85
Distribution-QMin 0.15
DistributionFactory-DefaultBootstrapSize 100
Domain-SmallVolume 1e-12
Drawable-AlternativePattern S
Drawable-DataThreshold 2000
Drawable-DefaultColor blue
Drawable-DefaultFillStyle solid
Drawable-DefaultLineStyle solid
Drawable-DefaultLineWidth 1
Drawable-DefaultPattern s
Drawable-DefaultPointStyle plus
Drawable-DefaultSurfaceColor white
Drawable-NoSpecifiedLabel ‘ ‘
DualLinearCombinationEvaluation-SmallCoefficient 0
FAST-DefaultInterferenceFactor 4
FAST-DefaultResamplingSize 1
FaureSequence-InitialSeed 1
Field-LevelNumber 30
FisherSnedecorFactory-D1LowerBound 0.01
FisherSnedecorFactory-D2LowerBound 0.01
FittingTest-ChiSquaredMinFrequency 5
FrankCopulaFactory-AbsolutePrecision 1e-14
FrankCopulaFactory-MaximumIteration 100
FrankCopulaFactory-RelativePrecision 1e-14
FrankCopulaFactory-ResidualPrecision 1e-14
FunctionalChaosAlgorithm-DefaultMaximumResidual 1e-06
FunctionalChaosAlgorithm-LargeSampleSize 10000
FunctionalChaosAlgorithm-MaximumTotalDegree 10
FunctionalChaosAlgorithm-PValueThreshold 0.001
FunctionalChaosAlgorithm-QNorm 0.5
FunctionalChaosAlgorithm-SmallSampleSize 1000
GaussKronrod-MaximumError 1e-12
GaussKronrod-MaximumSubIntervals 100
GaussProductExperiment-DefaultMarginalDegree 5
GaussianProcess-GibbsMaximumIteration 100
GaussianProcess-MaximalScaling 100000
GaussianProcess-StartingScaling 1e-13
GeneralLinearModelAlgorithm-DefaultOptimizationAlgorithm TNC
GeneralLinearModelAlgorithm-DefaultOptimizationLowerBound 0.01
GeneralLinearModelAlgorithm-DefaultOptimizationUpperBound 100
GeneralLinearModelAlgorithm-KeepCovariance true
GeneralLinearModelAlgorithm-LinearAlgebra LAPACK
GeneralLinearModelAlgorithm-MaximalScaling 100000
GeneralLinearModelAlgorithm-MeanEpsilon 1e-12
GeneralLinearModelAlgorithm-NormalizeData false
GeneralLinearModelAlgorithm-OptimizeParameters true
GeneralLinearModelAlgorithm-StartingScaling 1e-13
GeneralLinearModelAlgorithm-UnbiasedVariance true
GeneralLinearModelAlgorithm-UseAnalyticalAmplitudeEstimate true
GeneralizedExponential-DefaultTheta 1
GeneralizedExtremeValue-XiThreshold 1e-06
GeneralizedParetoFactory-MaximumAbsoluteError 1e-10
GeneralizedParetoFactory-MaximumConstraintError 1e-10
GeneralizedParetoFactory-MaximumEvaluationNumber 1000
GeneralizedParetoFactory-MaximumObjectiveError 1e-10
GeneralizedParetoFactory-MaximumRelativeError 1e-10
GeneralizedParetoFactory-SmallSize 20
Graph-DefaultHeight 480
Graph-DefaultLegendFontSize 1
Graph-DefaultWidth 640
Graph-NoSpecifiedLabel ‘ ‘
HMatrix-AdmissibilityFactor 2
HMatrix-AssemblyEpsilon 0.0001
HMatrix-ClusteringAlgorithm median
HMatrix-CompressionMethod 1
HMatrix-ForceSequential false
HMatrix-MaxLeafSize 100
HMatrix-MaxParallelLeaves 5000
HMatrix-RecompressionEpsilon 0.0001
HMatrix-ValidationDump 0
HMatrix-ValidationError 0
HMatrix-ValidationRerun 0
HaltonSequence-InitialSeed 1
HaselgroveSequence-InitialSeed 1
HyperbolicAnisotropicEnumerateFunction-DefaultQ 0.4
IntervalMesher-UseDiamond false
InverseNormalFactory-Method MLE
IteratedQuadrature-MaximumError 1e-07
IteratedQuadrature-MaximumSubIntervals 32
KFactor-DefaultIntegrationNodesNumber 256
KFactor-MaximumIteration 32
KFactor-Precision 1e-08
KFold-DefaultK 10
KarhunenLoeveP1Algorithm-RegularizationFactor 0
KarhunenLoeveP1Factory-RegularizationFactor 0
KarhunenLoeveQuadratureFactory-RegularizationFactor 0
KernelMixture-LargeSize 20
KernelMixture-PDFCDFDiscretization 1000
KernelMixture-SmallSize 50
KernelSmoothing-AbsolutePrecision 0
KernelSmoothing-BinNumber 1024
KernelSmoothing-CutOffPlugin 5
KernelSmoothing-MaximumIteration 50
KernelSmoothing-RelativePrecision 1e-05
KernelSmoothing-ResidualPrecision 1e-10
KernelSmoothing-SmallSize 250
KrigingAlgorithm-LinearAlgebra LAPACK
KrigingAlgorithm-MaximalScaling 100000
KrigingAlgorithm-StartingScaling 1e-13
Last-DefaultMaximumSize 65536
LeastSquaresMetaModelSelection-DecompositionMethod SVD
LeastSquaresMetaModelSelection-ErrorThreshold 0
LeastSquaresMetaModelSelection-MaximumErrorFactor 2
LinearCombinationEvaluation-SmallCoefficient 0
LinearModelFactory-DefaultLevelValue 0.95
LinearModelTest-DefaultDurbinWatsonHypothesis Equal
LinearModelTest-DefaultHarrisonMcCabeBreakpoint 0.5
LinearModelTest-DefaultHarrisonMcCabeSimulationSize 1000
LinearModelTest-DefaultLevel 0.95
LogNormal-CharacteristicFunctionIntegrationNodes 256
LogNormal-CharacteristicFunctionSmallSigmaThreshold 0.2
LogNormalFactory-AbsolutePrecision 1e-12
LogNormalFactory-EstimationMethod 0
LogNormalFactory-MaximumIteration 50
LogNormalFactory-RelativePrecision 1e-12
LogNormalFactory-ResidualPrecision 1e-12
MCMC-DefaultBurnIn 0
MCMC-DefaultThinning 1
MarginalTransformationEvaluation-DefaultTailThreshold 0.99
MarginalTransformationEvaluation-ParametersEpsilon 1e-14
MarginalTransformationEvaluation-Simplify 1
MartinezSensitivityAlgorithm-UseAsymptoticInterval false
MaternModel-DefaultNu 1.5
MaternModel-DefaultTheta 1
Matrix-DefaultSmallPivot 1e-07
Matrix-SymmetryThreshold 1e-12
Matrix-size-visible-in-str-from 5
MaximumEntropyOrderStatisticsDistribution-CDFIntegrationNodesNumber 16
MaximumEntropyOrderStatisticsDistribution-CheckMarginals true
MaximumEntropyOrderStatisticsDistribution-ExponentialFactorDiscretization 100
MaximumEntropyOrderStatisticsDistribution-MaximumApproximationSubdivision 2
MaximumEntropyOrderStatisticsDistribution-MaximumQuantileIteration 10
MaximumEntropyOrderStatisticsDistribution-SupportShift 1e-15
MaximumEntropyOrderStatisticsDistribution-UseApproximation true
MaximumLikelihoodFactory-MaximumAbsoluteError 1e-10
MaximumLikelihoodFactory-MaximumConstraintError 1e-10
MaximumLikelihoodFactory-MaximumEvaluationNumber 1000
MaximumLikelihoodFactory-MaximumObjectiveError 1e-10
MaximumLikelihoodFactory-MaximumRelativeError 1e-10
MeixnerDistribution-CDFDiscretization 10000
MeixnerDistribution-CDFIntegrationNodesNumber 32
MeixnerDistribution-MaximumAbsoluteError 1e-12
MeixnerDistribution-MaximumConstraintError 1e-12
MeixnerDistribution-MaximumObjectiveError 1e-12
MeixnerDistribution-MaximumRelativeError 1e-12
Mesh-LargeSize 5000
Mesh-UseKDTree 1
Mesh-VertexEpsilon 1e-12
MethodOfMomentsFactory-MaximumAbsoluteError 1e-10
MethodOfMomentsFactory-MaximumConstraintError 1e-10
MethodOfMomentsFactory-MaximumEvaluationNumber 1000
MethodOfMomentsFactory-MaximumObjectiveError 1e-10
MethodOfMomentsFactory-MaximumRelativeError 1e-10
Mixture-LargeSize 20
Mixture-PDFCDFDiscretization 1000
Mixture-SmallSize 50
Mixture-SmallWeight 1e-12
Multinomial-eta 1e-09
Multinomial-smallA 10
NegativeBinomialFactory-AbsolutePrecision 1e-12
NegativeBinomialFactory-MaximumIteration 50
NegativeBinomialFactory-RelativePrecision 1e-12
NegativeBinomialFactory-ResidualPrecision 1e-12
NonCenteredFiniteDifferenceGradient-DefaultEpsilon 1e-07
NonCentralStudent-CDFAlgo 0
Normal-MarginalIntegrationNodesNumber 16
Normal-MaximumCDFEpsilon 5e-06
Normal-MaximumNumberOfPoints 10000000
Normal-MinimumCDFEpsilon 0.05
Normal-MinimumNumberOfPoints 100000
Normal-SmallDimension 6
NumericalMathEvaluation-DefaultPointNumber 129
NumericalMathEvaluation-ParameterEpsilon 1e-07
NumericalSample-PrintEllipsisSize 3
NumericalSample-PrintEllipsisThreshold 1000
NumericalSample-SmallKendallTau 23
OptimizationAlgorithm-DefaultLevelValue 0
OptimizationAlgorithm-DefaultMaximumAbsoluteError 1e-05
OptimizationAlgorithm-DefaultMaximumConstraintError 1e-05
OptimizationAlgorithm-DefaultMaximumEvaluationNumber 100000
OptimizationAlgorithm-DefaultMaximumIteration 100
OptimizationAlgorithm-DefaultMaximumRelativeError 1e-05
OptimizationAlgorithm-DefaultMaximumResidualError 1e-05
OrderStatisticsMarginalChecker-OptimizationEpsilon 1e-07
OrderStatisticsMarginalChecker-QuantileIteration 100
Os-RemoveFiles 1
Os-create-process 0
Pie-HorizontalMargin 0.3
Pie-LabelThreshold 0.02
Pie-VerticalMargin 0.1
PiecewiseHermiteEvaluation-EpsilonRegular 1e-12
PiecewiseLinearEvaluation-EpsilonRegular 1e-12
ProductDistribution-LargeCharacteristicFunctionArgument 10
R-executable-command /usr/bin/R
RandomGenerator-InitialSeed 0
RandomMixture-DefaultAlpha 5
RandomMixture-DefaultBeta 8.5
RandomMixture-DefaultBlockMax 16
RandomMixture-DefaultBlockMin 3
RandomMixture-DefaultCDFEpsilon 1e-10
RandomMixture-DefaultMaxSize 65536
RandomMixture-DefaultPDFEpsilon 1e-10
RandomMixture-GraphCDFEpsilon 1e-05
RandomMixture-GraphPDFEpsilon 1e-05
RandomMixture-MarginalIntegrationNodesNumber 128
RandomMixture-MaximumIntegrationNodesNumber 1024
RandomMixture-ProjectionDefaultSize 25
RandomMixture-SmallSize 100
ReverseHaltonSequence-InitialSeed 1
RiceFactory-AbsolutePrecision 1e-12
RiceFactory-MaximumIteration 10
RiceFactory-RelativePrecision 1e-12
RiceFactory-ResidualPrecision 1e-12
RootStrategy-DefaultMaximumDistance 8
RootStrategy-DefaultStepSize 1
SQP-DefaultOmega 0.0001
SQP-DefaultSmooth 1.2
SQP-DefaultTau 0.5
Simulation-DefaultBlockSize 1
Simulation-DefaultMaximumCoefficientOfVariation 0.1
Simulation-DefaultMaximumOuterSampling 1000
Simulation-DefaultMaximumStandardDeviation 0
SimulationResult-DefaultConfidenceLevel 0.95
SimulationSensitivityAnalysis-DefaultSampleMargin 400
SobolIndicesAlgorithm-DefaultBlockSize 1
SobolIndicesAlgorithm-DefaultBootstrapConfidenceLevel 0.95
SobolIndicesAlgorithm-DefaultBootstrapSize 100
SobolSequence-InitialSeed 1
Solver-DefaultAbsoluteError 1e-05
Solver-DefaultMaximumFunctionEvaluation 100
Solver-DefaultRelativeError 1e-05
Solver-DefaultResidualError 1e-08
SpecFunc-MaximumIteration 1000
SpecFunc-Precision 2e-16
SpectralGaussianProcess-CholeskyCacheSize 16384
SpectralGaussianProcess-MaximalScaling 100000
SpectralGaussianProcess-StartingScaling 1e-13
SpectralModel-DefaultFrequencyNumber 128
SpectralModel-DefaultMaximumFrequency 5
SpectralModel-DefaultMinimumFrequency -5
SquaredExponential-DefaultTheta 1
StrongMaximumTest-DefaultDeltaPrecision 1e-07
StrongMaximumTest-Epsilon 1e-10
Student-MarginalIntegrationNodesNumber 16
Student-MaximumCDFEpsilon 5e-06
Student-MaximumNumberOfPoints 10000000
Student-MinimumCDFEpsilon 0.05
Student-MinimumNumberOfPoints 100000
Student-SmallDimension 6
SubsetSampling-DefaultBetaMin 2
SubsetSampling-DefaultConditionalProbability 0.1
SubsetSampling-DefaultMaximumOuterSampling 10000
SubsetSampling-DefaultProposalRange 2
TNC-DefaultAccuracy 0.0001
TNC-DefaultEta 0.25
TNC-DefaultFmin 1
TNC-DefaultMaxCGit 50
TNC-DefaultRescale 1.3
TNC-DefaultStepmx 10
Tensor-size-visible-in-str-from 5
TrapezoidalFactory-MaximumIteration 10000
TrapezoidalFactory-RhoBeg 0.1
TrapezoidalFactory-RhoEnd 1e-05
TruncatedDistribution-DefaultThresholdRealization 0.5
TruncatedNormalFactory-SigmaLowerBound 0.0001
UniVariatePolynomial-SmallDegree 400
UserDefined-SmallSize 10000
VisualTest-KendallPlot-MonteCarloSize 100
WeightedExperiment-DefaultSize 100
WhittleFactory-DefaultMaxFun 2000
WhittleFactory-DefaultRhoBeg 0.1
WhittleFactory-DefaultRhoEnd 1e-10
WhittleFactory-DefaultStartingPointScale 1
WhittleFactory-RootEpsilon 1e-06
cache-max-size 1024
csv-file-separator ;
output-files-timeout 2
parallel-threads 32
temporary-directory /tmp

Examples

Get some keys:

>>> import openturns as ot
>>> for key in ot.ResourceMap.GetKeys()[:4]:
...     print(key)
ARMA-MeanEpsilon
ARMALikelihoodFactory-DefaultMaxFun
ARMALikelihoodFactory-DefaultRhoBeg
ARMALikelihoodFactory-DefaultRhoEnd

Methods

Get(key) Access a parameter.
GetAsBool(key) Access a boolean parameter.
GetAsNumericalScalar(key) Access a floating-point parameter.
GetAsUnsignedInteger(key) Access an integer parameter.
GetKeys() Get the keys of the ResourceMap.
GetSize() Get the size of the ResourceMap.
Set(key, value) Access a parameter.
SetAsBool(key, value) Access a boolean parameter.
SetAsNumericalScalar(key, value) Access a floating-point parameter.
SetAsUnsignedInteger(key, value) Access an integer parameter.
__init__(*args, **kwargs)
static Get(key)

Access a parameter.

Parameters:

key : str

An identifier associated to the parameter.

Returns:

value : str

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.Get('DiscreteDistribution-SupportEpsilon')
'1.0e-14'
static GetAsBool(key)

Access a boolean parameter.

Parameters:

key : str

An identifier associated to the parameter.

Returns:

value : bool

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.GetAsBool('MaximumEntropyOrderStatisticsDistribution-CheckMarginals')
True
static GetAsNumericalScalar(key)

Access a floating-point parameter.

Parameters:

key : str

An identifier associated to the parameter.

Returns:

value : float

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.GetAsNumericalScalar('SQP-DefaultTau')
0.5
static GetAsUnsignedInteger(key)

Access an integer parameter.

Parameters:

key : str

An identifier associated to the parameter.

Returns:

value : int

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.GetAsUnsignedInteger('MCMC-DefaultBurnIn')
0...
static GetKeys()

Get the keys of the ResourceMap.

Returns:

keys : tuple of str

The list of identifiers.

static GetSize()

Get the size of the ResourceMap.

Returns:

size : positive int

The number of constants defined in the ResourceMap.

static Set(key, value)

Access a parameter.

Parameters:

key : str

An identifier associated to the parameter.

value : str

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.Set('DiscreteDistribution-SupportEpsilon', '1.0e-14')
static SetAsBool(key, value)

Access a boolean parameter.

Parameters:

key : str

An identifier associated to the parameter.

value : bool

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.SetAsBool('MaximumEntropyOrderStatisticsDistribution-CheckMarginals', True)
static SetAsNumericalScalar(key, value)

Access a floating-point parameter.

Parameters:

key : str

An identifier associated to the parameter.

value : float

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.SetAsNumericalScalar('SQP-DefaultTau', 0.5)
static SetAsUnsignedInteger(key, value)

Access an integer parameter.

Parameters:

key : str

An identifier associated to the parameter.

value : int

The value associated to that key.

Examples

>>> import openturns as ot
>>> ot.ResourceMap.SetAsUnsignedInteger('MCMC-DefaultBurnIn', 0)