Skip to content

simulateCW: add optional "prog_bar" arguments for generating a progress bar

Karl Wette requested to merge ANU-CGA/lalsuite:simulate-CW-progbar into master

Description

This MR adds a prog_bar optional argument to relevant methods of the CWSimulator class in the LALPulsar simulateCW module. This argument can be used to easily add a progress bar when generating SFTs or frames. For example, use tqdm by passing prog_bar=tqdm.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Classed as backwards compatible, since the new argument is optional.

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

Review Status

n/a

Merge request reports