bindings.py File Reference

Bindings for the ctypes interface for gateau. More...

Functions
CDLL	gateau.bindings.load_gateaulib ()
	Load the gateau shared library. More...
None	gateau.bindings.run_gateau (dict[str, any] instrument, dict[str, any] telescope, dict[str, any] atmosphere, dict[str, any] source, dict[str, any] cascade, int n_times, str outpath, str outscale, int seed, Union[str, None] resourcepath=None)
	Binding for running the gateau simulation. More...

Detailed Description

Bindings for the ctypes interface for gateau.

Function Documentation

load_gateaulib()

CDLL gateau.bindings.load_gateaulib

(

)

Load the gateau shared library.

Will detect the operating system and link the library accordingly.

Returns

The ctypes library containing the C/C++ functions.

run_gateau()

None gateau.bindings.run_gateau	(	dict[str, any]	instrument,
		dict[str, any]	telescope,
		dict[str, any]	atmosphere,
		dict[str, any]	source,
		dict[str, any]	cascade,
		int	n_times,
		str	outpath,
		str	outscale,
		int	seed,
		Union[str, None]	resourcepath = None
	)

Binding for running the gateau simulation.

Parameters

instrument	Dictionary containing instrument parameters.
telescope	Dictionary containing telescope parameters.
atmosphere	Dictionary containing atmosphere parameters.
source	Dictionary containing astronomical source parameters.
cascade	Dictionary containing the efficiencies and psds of the cascade.
n_times	Number of time evaluations.
outpath	Path to directory where gateau output is stored.
outscale	Scale of stored output (brightness temperature or power).
seed	Seed to use for noise calculations.
resourcepath	Path to resources folder. Defaults to None for autodetect.