TauREx-Ultranest

version 0.5.0-alpha

A plugin for TauREx 3.1 that provides the Ultranest sampler by Johannes Buchner for the retireval

Installation

Installing is simply done by running

pip install taurex_ultranest

You can install from source by doing:

git clone https://github.com/ucl-exoplanets/taurex-ultranest.git
cd taurex_ultranest
pip install .

Once installed you can select the sampler through the optimize keyword under Optimizer.

[Optimizer]
optimizer = ultranest
num_live_points=500
dlogz=0.5
dkl=0.5

The input arguments generally match the arguments from Ultranest.

Argument	Description	Type	Default	Required
num_live_points	minimum number of live points throughout the run	int	100
dlogz	Target evidence uncertainty.	float	0.5
dkl	Target posterior uncertainty.	float	0.5
frac_remain	Integrate until this fraction of the integral is left in the remainder.	float	0.01
cluster_num_live_points	require at least this many live points per detected cluster	Type	40
max_num_improvement_loops	limits the number of improvement loops.	int	Default
stepsampler	Choose which stepsampler to use. See StepSamplers	str	default
nsteps	number of accepted steps until the sample is considered independent.	int	10
step_scale	initial proposal size	float	1.0
adaptive_nsteps	Select a strategy to adapt the number of steps.	(False, 'proposal-distance', 'move-distance')	Default
region_filter	if True, use region to check if a proposed point can be inside before calling likelihood.	bool	False
resume	See docs	('resume', 'resume-similar', 'overwrite' or 'subfolder')	subfolder
log_dir	Directory to store sampling checkpoint files	str	.	Y

You can select a specific sampler by passing in the correct string to stepsampler. Documentation for each sampler is found here

Keyword	Sampler
cube-mh	CubeMHSampler
region-mh	RegionMHSampler
cube-slice	CubeSliceSampler
region-slice	RegionSliceSampler
region-sequentical-slice	RegionSequentialSliceSampler
ball-slice	BallSliceSampler
region-ball-slice	RegionBallSliceSampler

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for taurex-ultranest 0.5.0a0
File	Size	Uploaded
taurex_ultranest-0.5.0a0.tar.gz	8.0 kB	Oct 8, 2021	Details

Table of built distributions (wheels) for taurex-ultranest 0.5.0a0
File	Interpreter	ABI	Platform	Reset
taurex_ultranest-0.5.0a0-py3-none-any.whl 7.0 kB Oct 8, 2021	Python 3	none	any	Details

Total release size: 15.0 kB

Download URL	taurex_ultranest-0.5.0a0.tar.gz
Size	8.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`d5faea54c063f56fb84c74a42b2e50d4e9c341154d93026c7e8968c9484cddd6`
BLAKE2b-256 checksum How to use checksums	`f36d8af49a2caf11ddecf0988b24a7ff7cf2097c53b8a52a427913f2760bd557`
Upload date	Oct 8, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10`

Download URL	taurex_ultranest-0.5.0a0-py3-none-any.whl
Size	7.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ea66f27b7af85612470e230ecaa81df76a47a4ce9c0d1c2f064ea6acb51d0d7f`
BLAKE2b-256 checksum How to use checksums	`27d1b2a3fe635eb03f08d02ded32aab92c810ea8f45c2e587a0b31fbd493d1fa`
Upload date	Oct 8, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10`