The cascade.initialize module

CASCADe initialization module.

This Module defines the functionality to generate and read .ini files which are used to initialize CASCADe.

CASCADEe used the following environment variables:

CASCADE_WARNINGS

Switch to show or not show warnings. Can either be ‘on’ or ‘off’

CASCADE_STORAGE_PATH

Default storage directory for all functional data of CASCADe.

CASCADE_DATA_PATH

Default path to the input observational data.

CASCADE_SAVE_PATH

Default path to where CASCADe saves output.

CASCADE_INITIALIZATION_FILE_PATH:

Default directory for CASCADe initialization files.

CASCADE_SCRIPTS_PATH

Default path to the pipeline scripts of CASCADe.

CASCADE_LOG_PATH:

Default directory for logfiles.

On first import of the cascade package, a check is made if the default or user defined path to the input observational data and calibration files exist. If not, this is created and the functional data for CASCADe is copied into the directory, together with usage examples.

Examples

An example how the initilize module is used:

>>> import cascade
>>> default_path = cascade.initialize.cascade_default_initialization_path
>>> success = cascade.initialize.generate_default_initialization()

>>> tso = cascade.TSO.TSOSuite()
>>> print(cascade.initialize.cascade_configuration.isInitialized)
>>> print(tso.cascade_parameters.isInitialized)
>>> assert tso.cascade_parameters == cascade.initialize.cascade_configuration

>>> tso.execute('initialize', 'cascade_default.ini', path=default_path)
>>> print(cascade.initialize.cascade_configuration.isInitialized)
>>> print(tso.cascade_parameters.isInitialized)

>>> tso.execute("reset")
>>> print(cascade.initialize.cascade_configuration.isInitialized)
>>> print(tso.cascade_parameters.isInitialized)

cascade_warnings

‘str’:

If set to ‘off’ no warnings are shown. Default is ‘on’

cascade_default_path

‘pathlib.Path’:

CASCADe default path to data storage containing all needed functional data.

cascade_default_data_path

‘pathlib.Path’:

Default path to the input observational data.

cascade_default_save_path

‘pathlib.Path’:

Default path to where CASCADe saves output.

cascade_default_initialization_path

‘pathlib.Path’:

Default path to where CASCADe saves output.

cascade_default_scripts_path

‘pathlib.Path’:

Default path to the CASCADe pipeline scripts.

cascade_default_log_path

‘pathlib.Path’:

Default directory for CASCADe log files.

generate_default_initialization(observatory='HST', data='SPECTRUM', mode='STARING', observation='TRANSIT')

Generate default initialization files.

Convenience function to generate an example .ini file for CASCADe initialization. The file will be saved in the default directory defined by cascade_default_initialization_path. Returns True if successfully runned.

Parameters:

• observatory ('str', optional) – Name of the observatory, can either be ‘SPITZER’, ‘HST’ or ‘Generic’

• data ('str', optional) – Type of data, can either be ‘SPECTRUM’, ‘SPECTRAL_IMAGE’ or ‘SPECTRAL_CUBE’

• mode ('str', optional) – Observation type, can either be STARING, NODDED (Spitzer) or SCANNING (HST)

• observation ('str') – type of observed event. Can either be TRANSIT or ECLIPSE

Returns:

True

cascade_default_run_scripts_path

‘pathlib.Path’:

cascade_default_anaconda_environment

str:

class configurator(*args, **kwargs)

Bases: object

configurator class.

This class defined the configuration singleton which will provide all parameters needed to run the CASCADe to all modules of the code.

isInitialized = False

Will be set to True if initialized

reset()

Reset configurator.

If called, this function will remove all initialized parameters.

cascade_configuration

Instance if the configurator Singleton containing the entire configuration settings for the CASCADe code to work. This includes object and observation definitions and causal noise model settings.

setup_cascade_data(data_path_archive: Path, data_path_distribution: Path, url_distribution: str, functional_sections: list, example_sections: list, distribution_version: str) → None

Setup directory structure and data files needed by CASCAde.

Parameters:

• data_path_archive ('pathlib.Path') – Path to the user defined data archive.

• data_path_distribution ('pathlib.Path') – Path to the installed CASCADe distribution.

• url_distribution ('str') – URL git

• functional_sections ('list') – Sub directories for the functional data used by CASCADe.

• example_sections ('list') – Sub directories with examples how to use CASCADe

• distribution_version ('str') – Installed version of CASCADe

Returns:

None

initialize_cascade()

read_ini_files(*files)

Read .ini files using the configparser package.

Parameters:

files ('list' of 'str') – List of file names of initialization files to be read to initialize an instance of a TSO object.

Raises:

ValueError – An error is raised if the configuration file can not be found.

class _Singleton

Bases: type

Class defining a Singleton.