get_array_layout

pyvisgen.layouts.get_array_layout(array_layout: str | Path | DataFrame, writer: bool = False) → Stations

Reads a telescope layout txt file and converts it into a dataclass. Also allows a DataFrame to be passed that is then converted into a dataclass object. This allows custom layouts to be used in the simulation.

Available built-in arrays:

Experiment	Layout Name
ALMA	alma
ALMA (DSHARP)	alma_dsharp
DSA 2000W	dsa2000W
DSA 2000 31B	dsa2000_31b
EHT	eht
MeerKAT	meerkat
MeerKAT (test)*	meerkat_test
VLA	vla
VLBA	vlba
VLBA (light)*	vlba_light

* reduced layouts for testing purposes

Parameters:

array_layoutstr or Path or DataFrame

Name of telescope array or pd.DataFrame containing the array layout.

writerbool, optional

If True, return array DataFrame instead of Stations dataclass object.

Returns:

Stations

Stations dataclass comprising information on all stations in the given array layout.