TransportMaps.CLI.PostprocessBase

Module Contents

Classes

Postprocess

Base object for every object in the module.
class TransportMaps.CLI.PostprocessBase.Postprocess(**kwargs)[source]

Bases: TransportMaps.CLI.ScriptBase.Script

Base object for every object in the module.

This object provides functions for storage and parallelization.

property long_options[source]
cmd_usage_str = 'Usage: tmap-postprocess '[source]
opts_usage_str = Multiline-String[source]
Show Value
"""[-h -v -I]
  --input=INPUT --output=OUTPUT
  [--store-fig-dir=STR --store-fig-fmats=LIST
   --extra-tit=STR --no-plotting
   --aligned-conditionals=STR
     --alc-n-points-x-ax=INT
     --alc-n-tri-plots=INT
     --alc-anchor=LIST
     --alc-range=LIST
   --random-conditionals=STR
     --rndc-n-points-x-ax=INT
     --rndc-n-plots-x-ax=INT
     --rndc-anchor=LIST
     --rndc-range=LIST
   --var-diag=STR
     --var-diag-qtype=INT
     --var-diag-qnum=INT
   --aligned-marginals=STR
     --alm-n-points=INT
     --alm-n-tri-plots=INT
     --alm-scatter
   --quadrature=STR
     --quadrature-qtype=INT
     --quadrature-qnum=INT
     --quadrature-bsize=INT
   --importance-samples=INT
   --mcmc=STR
     --mcmc-samples=INT
     --mcmc-burnin=INT
     --mcmc-skip=INT
     --mcmc-ess
     --mcmc-ess-skip=INT
     --mcmc-ess-q=FLOAT
     --mcmc-ess-corr-plot
     --mcmc-ess-corr-plot-lag=LAG
     --mcmc-ess-hist-plot
     --mcmc-mh-eps=FLOAT
     --mcmc-mh-pcn
     --mcmc-hmc-eps=FLOAT
     --mcmc-hmc-nsteps=INT
   --chunk-size=INT --log=LOG --nprocs=INT]
"""
usage_str[source]
docs_distributions_str[source]
docs_mcmc_str[source]
docs_log_str[source]
docs_descr_str = Multiline-String[source]
Show Value
"""DESCRIPTION
Given a file (--input) storing the transport map pushing forward a base distribution
to a target distribution, provides a number of diagnositic routines.
All files involved are stored and loaded using the python package pickle and
an extra file OUTPUT.hdf5 is created to store big datasets in the hdf5 format.
In the following default values are shown in brackets."""
docs_options_str[source]
docs_str[source]
usage()[source]
description()[source]
store_figure(fig, fname)[source]
store_postproc_data(fname)[source]
_load_opts(opts)[source]
_init_self_variables()[source]
_check_required_args()[source]
load()[source]
close()[source]
aligned_conditionals(mpi_pool)[source]
random_conditionals(mpi_pool)[source]
variance_diagnostic(mpi_pool)[source]
aligned_marginals(mpi_pool)[source]
quadratures(mpi_pool)[source]
importance_sampling(mpi_pool)[source]
mcmc(mpi_pool)[source]
run(mpi_pool)[source]