API

• ultranest package
  • Submodules
  • ultranest.calibrator module
    • Calibration of step sampler
    • ReactiveNestedCalibrator
      • ReactiveNestedCalibrator.run()
      • ReactiveNestedCalibrator.plot()
  • ultranest.dychmc module
    • stop_criterion()
    • step_or_reflect()
    • build_tree()
    • tree_sample()
    • generate_uniform_direction()
    • DynamicCHMCSampler
      • DynamicCHMCSampler.set_gradient()
      • DynamicCHMCSampler.plot()
      • DynamicCHMCSampler.move()
      • DynamicCHMCSampler.create_problem()
      • DynamicCHMCSampler.adjust_stepsize()
      • DynamicCHMCSampler.region_changed()
      • DynamicCHMCSampler.adjust_nsteps()
  • ultranest.dyhmc module
    • stop_criterion()
    • leapfrog()
    • build_tree()
    • tree_sample()
    • find_beta_params_static()
    • find_beta_params_dynamic()
    • generate_momentum_normal()
    • generate_momentum()
    • generate_momentum_circle()
    • generate_momentum_flattened()
    • FlattenedProblem
      • FlattenedProblem.modify_Lgrad()
      • FlattenedProblem.generate_momentum()
    • DynamicHMCSampler
      • DynamicHMCSampler.plot()
      • DynamicHMCSampler.move()
      • DynamicHMCSampler.create_problem()
      • DynamicHMCSampler.adjust_stepsize()
      • DynamicHMCSampler.region_changed()
  • ultranest.flatnuts module
    • SingleJumper
      • SingleJumper.prepare_jump()
      • SingleJumper.check_gaps()
      • SingleJumper.make_jump()
    • DirectJumper
      • DirectJumper.prepare_jump()
      • DirectJumper.check_gaps()
      • DirectJumper.make_jump()
    • IntervalJumper
      • IntervalJumper.prepare_jump()
      • IntervalJumper.make_jump()
    • ClockedSimpleStepSampler
      • ClockedSimpleStepSampler.reset()
      • ClockedSimpleStepSampler.reverse()
      • ClockedSimpleStepSampler.set_nsteps()
      • ClockedSimpleStepSampler.is_done()
      • ClockedSimpleStepSampler.expand_onestep()
      • ClockedSimpleStepSampler.expand_to_step()
      • ClockedSimpleStepSampler.get_independent_sample()
    • ClockedStepSampler
      • ClockedStepSampler.continue_sampling()
      • ClockedStepSampler.expand_to()
      • ClockedStepSampler.eval_at()
      • ClockedStepSampler.reflect_at()
      • ClockedStepSampler.next()
    • ClockedBisectSampler
      • ClockedBisectSampler.continue_sampling()
      • ClockedBisectSampler.expand_to()
      • ClockedBisectSampler.bisect_at()
      • ClockedBisectSampler.next()
    • ClockedNUTSSampler
      • ClockedNUTSSampler.reset()
      • ClockedNUTSSampler.next()
      • ClockedNUTSSampler.sample_chain_point()
      • ClockedNUTSSampler.build_tree()
  • ultranest.hotstart module
    • Warm start
    • get_auxiliary_problem()
    • get_extended_auxiliary_problem()
    • get_extended_auxiliary_independent_problem()
    • compute_quantile_intervals()
    • compute_quantile_intervals_refined()
    • get_auxiliary_contbox_parameterization()
    • reuse_samples()
  • ultranest.integrator module
    • Nested sampling integrators
    • ReactiveNestedSampler
      • ReactiveNestedSampler.run()
      • ReactiveNestedSampler.run_iter()
      • ReactiveNestedSampler.store_tree()
      • ReactiveNestedSampler.print_results()
      • ReactiveNestedSampler.plot()
      • ReactiveNestedSampler.plot_corner()
      • ReactiveNestedSampler.plot_trace()
      • ReactiveNestedSampler.plot_run()
    • NestedSampler
      • NestedSampler.run()
      • NestedSampler.print_results()
      • NestedSampler.plot()
    • read_file()
    • warmstart_from_similar_file()
  • ultranest.mlfriends module
    • Region construction methods
    • AffineLayer
      • AffineLayer.create_new()
      • AffineLayer.optimize()
      • AffineLayer.transform()
      • AffineLayer.untransform()
    • LocalAffineLayer
      • LocalAffineLayer.create_new()
    • MLFriends
      • MLFriends.compute_enlargement()
      • MLFriends.compute_maxradiussq()
      • MLFriends.compute_mean_pair_distance()
      • MLFriends.create_ellipsoid()
      • MLFriends.estimate_volume()
      • MLFriends.inside()
      • MLFriends.inside_ellipsoid()
      • MLFriends.sample()
      • MLFriends.sample_from_boundingbox()
      • MLFriends.sample_from_points()
      • MLFriends.sample_from_transformed_boundingbox()
      • MLFriends.sample_from_wrapping_ellipsoid()
      • MLFriends.set_transformLayer()
    • MaxPrincipleGapAffineLayer
      • MaxPrincipleGapAffineLayer.create_new()
    • RobustEllipsoidRegion
      • RobustEllipsoidRegion.compute_enlargement()
      • RobustEllipsoidRegion.estimate_volume()
      • RobustEllipsoidRegion.inside()
      • RobustEllipsoidRegion.sample()
      • RobustEllipsoidRegion.sample_from_boundingbox()
      • RobustEllipsoidRegion.sample_from_transformed_boundingbox()
      • RobustEllipsoidRegion.sample_from_wrapping_ellipsoid()
    • ScalingLayer
      • ScalingLayer.create_new()
      • ScalingLayer.optimize()
      • ScalingLayer.optimize_wrap()
      • ScalingLayer.set_clusterids()
      • ScalingLayer.transform()
      • ScalingLayer.untransform()
      • ScalingLayer.unwrap()
      • ScalingLayer.wrap()
    • SimpleRegion
      • SimpleRegion.compute_enlargement()
      • SimpleRegion.create_ellipsoid()
    • WrappingEllipsoid
      • WrappingEllipsoid.compute_enlargement()
      • WrappingEllipsoid.create_ellipsoid()
      • WrappingEllipsoid.inside()
      • WrappingEllipsoid.update_center()
    • bounding_ellipsoid()
    • compute_mean_pair_distance()
    • find_nearby()
    • make_eigvals_positive()
    • subtract_nearby()
    • update_clusters()
    • vol_prefactor()
  • ultranest.netiter module
    • Graph-based nested sampling
    • TreeNode
    • BreadthFirstIterator
      • BreadthFirstIterator.reset()
      • BreadthFirstIterator.next_node()
      • BreadthFirstIterator.drop_next_node()
      • BreadthFirstIterator.expand_children_of()
    • print_tree()
    • dump_tree()
    • count_tree()
    • count_tree_between()
    • find_nodes_before()
    • PointPile
      • PointPile.add()
      • PointPile.getu()
      • PointPile.getp()
      • PointPile.make_node()
    • SingleCounter
      • SingleCounter.reset()
      • SingleCounter.logZremain
      • SingleCounter.passing_node()
    • MultiCounter
      • MultiCounter.reset()
      • MultiCounter.logZ_bs
      • MultiCounter.logZerr_bs
      • MultiCounter.insertion_order_runlength
      • MultiCounter.insertion_order_converged
      • MultiCounter.passing_node()
    • combine_results()
    • logz_sequence()
  • ultranest.ordertest module
    • U test for a uniform distribution of integers
    • infinite_U_zscore()
    • UniformOrderAccumulator
      • UniformOrderAccumulator.reset()
      • UniformOrderAccumulator.add()
      • UniformOrderAccumulator.zscore
  • ultranest.pathsampler module
    • SamplingPathSliceSampler
      • SamplingPathSliceSampler.generate_direction()
      • SamplingPathSliceSampler.adjust_accept()
      • SamplingPathSliceSampler.adjust_outside_region()
      • SamplingPathSliceSampler.move()
    • SamplingPathStepSampler
      • SamplingPathStepSampler.start()
      • SamplingPathStepSampler.start_path()
      • SamplingPathStepSampler.terminate_path()
      • SamplingPathStepSampler.set_gradient()
      • SamplingPathStepSampler.generate_direction()
      • SamplingPathStepSampler.adjust_accept()
      • SamplingPathStepSampler.adjust_outside_region()
      • SamplingPathStepSampler.adjust_scale()
      • SamplingPathStepSampler.movei()
      • SamplingPathStepSampler.move()
      • SamplingPathStepSampler.reflect()
      • SamplingPathStepSampler.get_point()
    • OtherSamplerProxy
      • OtherSamplerProxy.accumulate_statistics()
      • OtherSamplerProxy.adjust_scale()
      • OtherSamplerProxy.startup()
      • OtherSamplerProxy.start_direction()
      • OtherSamplerProxy.plot()
  • ultranest.plot module
    • Plotting utilities
    • runplot()
    • cornerplot()
    • traceplot()
    • PredictionBand
      • PredictionBand.add()
      • PredictionBand.set_shadeargs()
      • PredictionBand.set_lineargs()
      • PredictionBand.get_line()
      • PredictionBand.shade()
      • PredictionBand.line()
  • ultranest.popstepsampler module
    • Vectorized step samplers
    • generate_cube_oriented_direction()
    • generate_cube_oriented_direction_scaled()
    • generate_random_direction()
    • generate_region_oriented_direction()
    • generate_region_random_direction()
    • PopulationRandomWalkSampler
      • PopulationRandomWalkSampler.region_changed()
    • PopulationSliceSampler
      • PopulationSliceSampler.region_changed()
      • PopulationSliceSampler.setup_start()
      • PopulationSliceSampler.status
      • PopulationSliceSampler.setup_brackets()
      • PopulationSliceSampler.advance()
      • PopulationSliceSampler.shift()
    • PopulationSimpleSliceSampler
      • PopulationSimpleSliceSampler.region_changed()
  • ultranest.samplingpath module
    • nearest_box_intersection_line()
    • box_line_intersection()
    • linear_steps_with_reflection()
    • get_sphere_tangent()
    • get_sphere_tangents()
    • reflect()
    • distances()
    • isunitlength()
    • angle()
    • extrapolate_ahead()
    • interpolate()
    • SamplingPath
      • SamplingPath.add()
      • SamplingPath.reset()
      • SamplingPath.plot()
      • SamplingPath.interpolate()
      • SamplingPath.extrapolate()
    • ContourSamplingPath
      • ContourSamplingPath.add()
      • ContourSamplingPath.interpolate()
      • ContourSamplingPath.extrapolate()
      • ContourSamplingPath.gradient()
  • ultranest.solvecompat module
    • pymultinest_solve_compat()
  • ultranest.stepfuncs module
    • Efficient helper functions for vectorized step-samplers
    • evolve()
    • evolve_prepare()
    • evolve_update()
    • generate_cube_oriented_direction()
    • generate_cube_oriented_direction_scaled()
    • generate_differential_direction()
    • generate_mixture_random_direction()
    • generate_random_direction()
    • generate_region_oriented_direction()
    • generate_region_random_direction()
    • step_back()
    • update_vectorised_slice_sampler()
    • within_unit_cube()
  • ultranest.stepsampler module
    • MCMC-like step sampling
    • generate_random_direction()
    • generate_cube_oriented_direction()
    • generate_cube_oriented_differential_direction()
    • generate_differential_direction()
    • generate_partial_differential_direction()
    • generate_region_oriented_direction()
    • generate_region_random_direction()
    • generate_mixture_random_direction()
    • generate_region_sample_direction()
    • inside_region()
    • adapt_proposal_total_distances()
    • adapt_proposal_total_distances_NN()
    • adapt_proposal_summed_distances()
    • adapt_proposal_summed_distances_NN()
    • adapt_proposal_move_distances()
    • adapt_proposal_move_distances_midway()
    • select_random_livepoint()
    • IslandPopulationRandomLivepointSelector
    • StepSampler
      • StepSampler.plot()
      • StepSampler.mean_jump_distance
      • StepSampler.far_enough_fraction
      • StepSampler.get_info_dict()
      • StepSampler.print_diagnostic()
      • StepSampler.plot_jump_diagnostic_histogram()
      • StepSampler.move()
      • StepSampler.adjust_outside_region()
      • StepSampler.adjust_accept()
      • StepSampler.adapt_nsteps()
      • StepSampler.finalize_chain()
      • StepSampler.new_chain()
      • StepSampler.region_changed()
    • MHSampler
      • MHSampler.move()
    • CubeMHSampler()
    • RegionMHSampler()
    • SliceSampler
      • SliceSampler.new_chain()
      • SliceSampler.adjust_accept()
      • SliceSampler.adjust_outside_region()
      • SliceSampler.move()
    • CubeSliceSampler()
    • RegionSliceSampler()
    • BallSliceSampler()
    • RegionBallSliceSampler()
    • SequentialDirectionGenerator
    • SequentialRegionDirectionGenerator
    • RegionSequentialSliceSampler()
    • OrthogonalDirectionGenerator
    • SpeedVariableGenerator
    • SpeedVariableRegionSliceSampler()
    • ellipsoid_bracket()
    • crop_bracket_at_unit_cube()
  • ultranest.store module
    • Storage for nested sampling points
    • NullPointStore
      • NullPointStore.reset()
      • NullPointStore.close()
      • NullPointStore.flush()
      • NullPointStore.add()
      • NullPointStore.pop()
    • FilePointStore
      • FilePointStore.reset()
      • FilePointStore.close()
      • FilePointStore.flush()
      • FilePointStore.pop()
    • TextPointStore
      • TextPointStore.add()
    • HDF5PointStore
      • HDF5PointStore.FILES_OPENED
      • HDF5PointStore.add()
  • ultranest.utils module
    • Utility functions for logging and statistics
    • create_logger()
    • make_run_dir()
    • vectorize()
    • resample_equal()
    • listify()
    • quantile()
    • vol_prefactor()
    • is_affine_transform()
    • normalised_kendall_tau_distance()
    • verify_gradient()
    • distributed_work_chunk_size()
    • submasks()
  • ultranest.viz module
    • Live point visualisations
    • round_parameterlimits()
    • nicelogger()
    • isnotebook()
    • LivePointsWidget
      • LivePointsWidget.initialize()
    • get_default_viz_callback()
  • Module contents