diff --git a/docs/basics-of-parameter-estimation.txt b/docs/basics-of-parameter-estimation.txt index a278d40ef593000ffe443f9a474ad875df48c925..e3be9d6a0f121ffd41b2e747ee5d006268b2439d 100644 --- a/docs/basics-of-parameter-estimation.txt +++ b/docs/basics-of-parameter-estimation.txt @@ -87,7 +87,6 @@ a likelihood and prior, and running nested sampling using `tupak`. .. literalinclude:: /../examples/other_examples/linear_regression.py :language: python - :emphasize-lines: 12,15-18 :linenos: Running the script above will make a few images. Firstly, the plot of the data: diff --git a/docs/images/H1_frequency_domain_data.png b/docs/images/H1_frequency_domain_data.png new file mode 100644 index 0000000000000000000000000000000000000000..0148acdd831436745023d96bb6cd7124dfb89a3a Binary files /dev/null and b/docs/images/H1_frequency_domain_data.png differ diff --git a/docs/images/basic_tutorial_corner.png b/docs/images/basic_tutorial_corner.png new file mode 100644 index 0000000000000000000000000000000000000000..1389beb7f96cef8bea12e7499c01413aad08d182 Binary files /dev/null and b/docs/images/basic_tutorial_corner.png differ diff --git a/docs/index.txt b/docs/index.txt index 9ea692b656140d7a5eb990dc218ddb36e963321f..561391e6480a2767c963b69b1e3d952b4cde4a62 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -9,6 +9,7 @@ Welcome to tupak's documentation! :caption: Contents: basics-of-parameter-estimation + compact-binary-coalescence-parameter-estimation tupak-output likelihood samplers diff --git a/examples/injection_examples/basic_tutorial.py b/examples/injection_examples/basic_tutorial.py index 0d5ede77386bc38853aba7ca63042967a5d51efb..1fb7d87282e40eb2c1b59aa757933be16c11f7ee 100644 --- a/examples/injection_examples/basic_tutorial.py +++ b/examples/injection_examples/basic_tutorial.py @@ -47,12 +47,15 @@ priors = dict() # so for this example we will set almost all of the priors to be equall to their injected values. This implies the # prior is a delta function at the true, injected value. In reality, the sampler implementation is smart enough to # not sample any parameter that has a delta-function prior. -for key in ['a_1', 'a_2', 'tilt_1', 'tilt_2', 'phi_12', 'phi_jl', 'phase', 'psi', 'ra', 'dec', 'geocent_time']: +for key in ['a_1', 'a_2', 'tilt_1', 'tilt_2', 'phi_12', 'phi_jl', 'phase', 'psi', 'ra', 'dec', 'luminosity_distance', 'iota']: priors[key] = injection_parameters[key] # The above list does *not* include mass_1, mass_2, iota and luminosity_distance, which means those are the parameters # that will be included in the sampler. If we do nothing, then the default priors get used. -priors['luminosity_distance'] = tupak.prior.create_default_prior(name='luminosity_distance') +#priors['luminosity_distance'] = tupak.prior.create_default_prior(name='luminosity_distance') +priors['geocent_time'] = tupak.prior.Uniform(injection_parameters['geocent_time'] - 1, + injection_parameters['geocent_time'] + 1, + 'geocent_time') # Initialise the likelihood by passing in the interferometer data (IFOs) and the waveoform generator likelihood = tupak.GravitationalWaveTransient(interferometers=IFOs, waveform_generator=waveform_generator) diff --git a/tupak/__init__.py b/tupak/__init__.py index d752a893f5fc586bba8f05885d23ef673e2fb214..b2b4d20d1a2ede870e94b5bb9223385770a24c32 100644 --- a/tupak/__init__.py +++ b/tupak/__init__.py @@ -4,7 +4,12 @@ tupak Tupak is The User friendly Parameter estimAtion Kode -FILL IN THE REST +The aim of tupak is to provide user friendly interface to perform parameter +estimation. It is primarily designed and built for inference of compact +binary coalesence events in interferometric data, but it can also be used for +more general problems. + +For installation instructions see https://git.ligo.org/Monash/tupak """