reggae.qtconsole

Attributes

FIELDS

BOUNDS

STYLE

Classes

ReggaeDebugWindow

GUI tuning tool for dipole mixed-mode parameters.

Signals

Signal handler

Worker

Worker thread

Module Contents

reggae.qtconsole.FIELDS
reggae.qtconsole.BOUNDS
reggae.qtconsole.STYLE
class reggae.qtconsole.ReggaeDebugWindow(input=None, session=None)

Bases: matplotlib.backends.qt_compat.QtWidgets.QMainWindow

GUI tuning tool for dipole mixed-mode parameters. There are two ways we recommend launching this:

1. Running reggae as a raw python module: python -m reggae This will instantiate an instance of the GUI with no arguments.

2. Instantiating a class by passing an existing DipoleStar or pbjam.star instance as positional argument. This is equivalent to launching an empty GUI, and using either of the import buttons in the sidebar.

qapp
init_ui()

Initialize UI parameters

tqdm(gen, total=None, **kwargs)

Make a custom tqdm

Parameters

gen: generator obj

Generator object to loop through

total: int, optional

Total number of iterations in the generator. Default is None.

sweep(i)

Parameter sweep over given bounds

recompute()

Make the recompute button

replot(θreg, norm, label='Manual')

Make button to regenerate echelle diagrams

load_pickle(description)

Button to load pickle file

Parameters

descripttion: str

Button tooltip.

write_pickle(obj, description)

Button to write pickle file

Parameters

descripttion: str

Button tooltip.

load_pbjam(*, pbjam=None)

Button to load pickled PBjam star class instance

Parameters

pbjam: obj

PBjam.star.star class instance.

load_reggae(*, reggae=None)

Button to load pickled reggae star class instance

Parameters

reggae: obj

reggae.dipolestar.dipolestar class instance.

load_reggae_actions()

Button to populate diagnostic plots

update_n_g()

Update the list of g-mode radial orders.

get_ΔΠ()

Get the period spacing

get_q()

Get the classical coupling strength

get_ν_p()

Get the p-mode frequencies

frequency_echelle_power_plot()

Generate a frequency-echelle power diagram.

period_echelle_power_plot()

Generate a stretched period-echelle power diagram.

sync_state()

Synchronise UI with state of reggae object

load(*, session=None)

Load GUI session output

print(text)

Custom print function

Parameters

text: str

String to print.

optimize(maxiter=1000)

Start optimization

Parameters

maxiter: int, optional

Maximum iterations to try optimization. Default is 10000.

de()

Button to start differential evolution.

newbounds()

Set new bounds on the model parameters.

dynesty()

Initialize and run a Dynesty nested sampling run.

get_state()
get_bounds()
dump()

Store the Reggae session variables.

dump_reggae()

Pickle the reggae result.

plot_MCMC()

Plot the MCMC sampler results.

closeEvent(*args)
reset()

Reset the UI to starting conditions.

class reggae.qtconsole.Signals

Bases: matplotlib.backends.qt_compat.QtCore.QObject

Signal handler

error
finished
result
class reggae.qtconsole.Worker(fn, *args, **kwargs)

Bases: matplotlib.backends.qt_compat.QtCore.QRunnable

Worker thread

Inherits from QRunnable to handler worker thread setup, signals and wrap-up.

Parameters

callback: callable

The function callback to run on this worker thread. Supplied args and kwargs will be passed through to the runner.

args: list

Arguments to pass to the callback function

kwargs:cdict

Keywords to pass to the callback function

fn
args = ()
kwargs
signals
run()

Initialise the runner function with passed args, kwargs.