gateau.simulator.simulator Class Reference

Interface for gateau simulations. More...

Inheritance diagram for gateau.simulator.simulator:

Public Member Functions
None	__init__ (self, bool verbose=True)
	Create an interface object for gateau. More...
None	setLoggingVerbosity (self, bool verbose)
	Set or change the verbosity of the gateau logger. More...
Union[None, dict[str, any]]	initialise (self, float t_obs, float az0, float el0, Union[Callable, list[Callable]] scan_func, dict[str, any] instrument_dict, dict[str, any] telescope_dict, dict[str, any] atmosphere_dict, dict[str, any] source_dict, Union[list[dict[str, any]], str] cascade_list, str cascade_yaml="cascade.yaml", bool return_full=False)
	Initialise a gateau setup. More...
None	run (self, Union[str, Path] outname="out", bool overwrite=False, str outscale="Tb", int seed=0)
	Run a gateau simulation. More...

Public Attributes
	cascade
	initialisedSetup
	END SETUP INITIALISATION ####.
	n_times
	INITIALISING OBSERVATION PARAMETERS #### Calculate number of time evaluations Note that, in order to simplify TLS noise calculations, we make n_times even.

Static Public Attributes
	atmosphere = None
	telescope = None
	instrument = None
	observation = None
	source = None
	cascadeList = None
bool	initialisedSetup = False
	clog_mgr = CustomLogger(os.path.basename(__file__))
	clog = clog_mgr.getCustomLogger()
float	c = 2.99792458e8

Detailed Description

Interface for gateau simulations.

Constructor & Destructor Documentation

__init__()

None gateau.simulator.simulator.__init__	(		self,
		bool	verbose = True
	)

Create an interface object for gateau.

Parameters

verbose

Set verbosity of logger. If False, will not log any output to screen. If True, will log simulation information, warnings, and errors to screen. Default is True.

Member Function Documentation

setLoggingVerbosity()

None gateau.simulator.simulator.setLoggingVerbosity	(		self,
		bool	verbose
	)

Set or change the verbosity of the gateau logger.

Parameters

verbose

Set verbosity of logger. If False, will not log any output to screen. If True, will log simulation information, warnings, and errors to screen.

---

The documentation for this class was generated from the following file:

• src/gateau/simulator.py