ngect.cli module

ngect cli interface. adapted from the ngVLA subarray sensitivity and key performance metric calculator by V. Rosero.

ngect.cli.calculate_sensitivity(subarray, freq=-1, theta=-1, t_obs=1, delta_v=10000.0, verbose=True)

Calculate sensitivities for a given observing setup.

Parameters

subarraystr

Subarray name (e.g., "sba", "core", "main+long").

freqfloat, optional

Representative frequency in GHz. Default is -1 (uses engine logic).

thetafloat, optional

Target resolution in arcsec (use -1 for native resolution). Default -1.

t_obsfloat, optional

On-source time in hours. Default 1.

delta_vfloat, optional

Channel width in m/s. Default 1e4.

verbosebool, optional

If True, log a human-readable report to the logger. Default True.

Returns

dict

A result mapping from ngect.engine.ArrayPerformance.ect() containing sensitivities and configuration details for the last processed specmode.

Notes

This function evaluates both continuum (cont) and spectral line (line) modes in sequence, logging their results. The returned dictionary corresponds to the last evaluated mode.

ngect.cli.cli_run()

Entry point for the ngECT command-line interface.

Parses CLI arguments and delegates to calculate_sensitivity() to compute exposure metrics. This mirrors the historical ngVLA_sensitivity_calculator.py workflow for comparison purposes.

Examples

From a shell, compute sensitivities for a given setup:

>>> 
... ngect_cli main+long 24.5 1 --t_obs 4 --delta_v 2e3