tabsim 0.0.1__py3-none-any.whl

tabsim/data/aux_data/satellite.ole

@@ -0,0 +1,3 @@
+sat_id,sat_name,elevation,inclination,lon_asc_node,periapsis
+1,sat1,20200000.0,55.0,41.0,-5.0
+2,sat2,19140000.0,64.8,17.0,-31.0

tabsim/data/aux_data/satellite.rfimodel

@@ -0,0 +1,3 @@
+sat_id,sat_name,sig_type,power,freq,band_width
+1,sat1,gauss,0.0000058,1227000000.0,10000000.0
+2,sat2,gauss,0.012,1227000000.0,10000000.0

tabsim/data/aux_data/stationary.loc

@@ -0,0 +1,4 @@
+loc_id,loc_name,latitude,longitude,elevation
+1,town1,-20.0,30.0,1050.0
+2,tower1,-20.0,20.0,1050.0
+3,tower2,-25.0,20.0,1050.0

tabsim/data/aux_data/stationary.rfimodel

@@ -0,0 +1,4 @@
+loc_id,loc_name,sig_type,power,freq,band_width
+1,town1,gauss,0.0006,1220000000.0,6000000.0
+2,tower1,gauss,0.00015,1220000000.0,6000000.0
+3,tower2,gauss,4e-05,1220000000.0,6000000.0

tabsim/data/config_files/sim_config_base.yaml

@@ -0,0 +1,172 @@
+###############################################################################################
+# This is base simulation config that is loaded and then updated with your provided config.
+# Populated parameters here are the default values used if none are specified in your config.
+###############################################################################################
+ast_sources:
+##########################################
+# Exponential shaped astronomical sources
+##########################################
+  exp:
+    path: null                # Optional - Path to skymodel
+    random:
+      n_src: 0                # Optional - Number of exponentially shaped sources to include
+      I_pow_law: 1.6          # Required if n_src > 0 - Exponent for power law intensity distribution
+      max_I: 1.0              # Required if n_src > 0 - Maximum intensity of intensity distribution in Jy
+      max_sep: 50.0           # Required if n_src > 0 - Maximum angular separation between sources in arcseconds      
+      min_I: 3sigma           # Required if n_src > 0 - Minimum intensity of intensity distribution in Jy (3sigma calculated from theoretical image noise)
+      n_beam: 5               # Required if n_src > 0 - Maximum angular separation between sources based on the theoretical synthesized beam width
+      random_seed: 123456     # Required if n_src > 0 - Random seed used for drawing locations, intensities and shapes
+      si_mean: 0.7            # Required if n_src > 0 - Mean of the Gaussian distribution to draw spectral indices from
+      si_std: 0.2             # Required if n_src > 0 - Sandard deviation of the Gaussian distribution to draw spectral indices from
+      size_mean: 30.0         # Required if n_src > 0 - Mean of the Gaussian distribution to draw source sizes from in arcseconds
+      size_std: 5.0           # Required if n_src > 0 - Standard deviation of the Gaussian distribution to draw spectral indices from
+#######################################
+# Gaussian shaped astronomical sources
+#######################################
+  gauss:
+    path: null                # Optional - Path to skymodel
+    random:
+      n_src: 0                # Optional - Number of Gaussian shaped sources to include
+      I_pow_law: 1.6          # Required if n_src > 0 - Exponent for power law intensity distribution
+      major_mean: 30.0        # Required if n_src > 0 - Mean of the Gaussian distribution to draw source size major axes from in arcseconds
+      major_std: 5.0          # Required if n_src > 0 - Standard deviation of the Gaussian distribution to draw source sizes from in arcseconds
+      max_I: 1.0              # Required if n_src > 0 - Maximum intensity of intensity distribution in Jy
+      max_sep: 50.0           # Required if n_src > 0 - Maximum angular separation between sources in arcseconds
+      min_I: 3sigma           # Required if n_src > 0 - Minimum intensity of intensity distribution in Jy (3sigma calculated from theoretical image noise)
+      minor_mean: 30.0        # Required if n_src > 0 - Mean of the Gaussian distribution to draw source size minor axes from in arcseconds
+      minor_std: 5.0          # Required if n_src > 0 - Standard deviation of the Gaussian distribution to draw source sizes from in arcseconds
+      n_beam: 5               # Required if n_src > 0 - Maximum angular separation between sources based on the theoretical synthesized beam width
+      random_seed: 123456     # Required if n_src > 0 - Random seed used for drawing locations, intensities and shapes
+      si_mean: 0.7            # Required if n_src > 0 - Mean of the Gaussian distribution to draw spectral indices from
+      si_std: 0.2             # Required if n_src > 0 - Sandard deviation of the Gaussian distribution to draw spectral indices from
+####################################
+# Point shaped astronomical sources
+####################################
+  point:
+    path: null                # Optional - Path to skymodel
+    random:
+      n_src: 0                # Optional - Number of point sources to include
+      I_pow_law: 1.6          # Required if n_src > 0 - Exponent for power law intensity distribution
+      max_I: 1.0              # Required if n_src > 0 - Maximum intensity of intensity distribution in Jy
+      max_sep: 50.0           # Required if n_src > 0 - Maximum angular separation between sources in arcseconds
+      min_I: 3sigma           # Required if n_src > 0 - Minimum intensity of intensity distribution in Jy (3sigma calculated from theoretical image noise)
+      n_beam: 5               # Required if n_src > 0 - Maximum angular separation between sources based on the theoretical synthesized beam width
+      random_seed: 123456     # Required if n_src > 0 - Random seed used for drawing locations, intensities and shapes
+      si_mean: 0.7            # Required if n_src > 0 - Mean of the Gaussian distribution to draw spectral indices from
+      si_std: 0.2             # Required if n_src > 0 - Sandard deviation of the Gaussian distribution to draw spectral indices from
+#################################################
+# Gaussian field realization astronomical source
+#################################################
+  pow_spec:
+    path: null                # Optional - Path to skymodel
+    random:
+      type: null              # Optional - Type of power spectrum to use. Currently only 'Cl' or 'Pk' is available which is a power law spectrum and power law with a knee respectively
+      random_seed: 1234       # Required if type is specified - Random seed used for drawing Gaussian field realization
+      fov_f: 1.2              # Required if type is specified - Fraction of the field of view to model (based on minimum frequency and dish diameter)
+      n_side: 128             # Required if type is specified - Number of pixel/point sources per sideof the sky image
+      A: 0.000513             # Required if type 'Cl' is specified - Amplitude of power spectrum at k=0 in mK^2
+      beta: 1.34              # Required if type 'Cl' is specified - Exponent of the power law spectrum
+      P0: 1e12                # Required if type 'Pk' is specified - Amplitude of power spectrum for k below 'k0'
+      k0: 1e1                 # Required if type 'Pk' is specified - Change point where the power spectrum changes from flat to a power law
+      gamma: 2.34             # Required if type 'Pk' is specified - Exponent of the power law portion of the power spectrum
+##################
+# Dask parameters
+##################
+dask:
+  max_chunk_MB: 100           # Required - Approximate size of the dask chunks to process in Megabytes
+###################
+# Diagnostoc plots
+###################
+diagnostics:
+  rfi_seps: True              # Optional - Whether to plot the angular separations, over time, between the pointing direction and the RFI sources.
+  src_alt: True               # Optional - Whether to plot the source altitude over time
+  uv_cov: True                # Optional - Whether to plot the uv distribution of the observation in metres
+##################
+# Gain parameters
+##################
+gains:
+  G0_mean: 1.0                # Optional - Mean of the Gaussian distribution for the starting gain amplitude (phase is uniformaly distributed when G0_mean!=1.0)
+  G0_std: 0.0                 # Optional - Standard deviation of the Gaussian distribution for the starting gain amplitude
+  Gt_std_amp: 0               # Optional - Standard deviation of the Gaussian distribution for the variability of the gain amplitude [%]
+  Gt_std_phase: 0             # Optional - Standard deviation of the Gaussian distribution for the variability of the gain phase [deg]
+  Gt_corr_amp: 3              # Optional - Correlation time of the Gaussian process for the time variability of the gain amplitude [hr]
+  Gt_corr_phase: 3            # Optional - Correlation time of the Gaussian process for the time variability of the gain phase [hr]
+  random_seed: 999            # Optional - Random seed used for drawing of gain parameters
+#########################
+# Observation parameters
+#########################
+observation:
+  start_time_jd: null         # Required - Centroid of the starting time in Julian date
+  start_time_isot: null       # Required - Centroid of the starting time in ISOT format e.g. 2024-02-21T12:47:32.123
+  start_time_lha: null        # Required - Centroid of the starting time in local hour angle in degrees
+  start_time: null            # Required - Centroid of the starting time in Greenwich mean sidereal time in seconds 
+  # Only one of the above is required to be specified, order of preference is start_time_jd, start_time_isot, start_time
+  SEFD: null                  # Required - System equivalent flux density of the antennas in Jy. Visibility noise is calculated from this, chan_width, and int_time
+  auto_corrs: False           # Optional - Whether to simulate the autocorrelations
+  chan_width: null            # Required if n_freq < 2 - The bandwidth of a single frequency channel in Hz
+  ra: null                    # Required - Right ascension of the target direction in decimal degrees
+  dec: null                   # Required - Declination of the target direction in decimal degrees
+  int_time: null              # Required - Integration time per time step in seconds
+  n_freq: null                # Required - Number of frequency channels to simulate
+  n_int: null                 # Required - Number of samples used to integrate within a single time step. 
+  n_time: null                # Required - Number of time steps to simulate
+  no_w: False                 # Optional - Whether to include the w-component in the baselines. Simulates a planar array at all times
+  random_seed: null           # Optional - Random seed to use for drawing the visibility noise
+  start_freq: null            # Required - Centroid of the starting frequency for the frequencies to simulate in Hz 
+  target_name: target         # Optional - Name of the target
+####################
+# Output parameters
+####################
+output:
+  zarr: True                  # Optional - Whether to save the output to a zarr file. This contains almost all inputs ot the simulation
+  ms: True                    # Optional - Whether to save the output to a Measurement Set file
+  flag_data: True             # Optional - Whether to apply ideal 3sigma flags
+  overwrite: False            # Optional - Whether to overwrite a previous simulation with the same name
+  path: ./                    # Optional - Path to where the simulation should be saved
+  prefix: null                # Optional - Prefix used in the simulation file name
+  suffix: null                # Optional - Suffix used in the simulation file name
+rfi_sources:
+#######################################
+# Circular trajectory based satellites
+#######################################
+  satellite:
+    # These parameters are used for simulating satellites with a circular path
+    sat_ids: []               # Optional - IDs of satellites to include where the orbital parameters and spectral models are defined in the following files
+    circ_path: null           # Required if sat_ids != [] - Path to the csv '.ole' file containing the satellite orbital parameters per satellite ID
+    spec_model: null          # Required if sat_ids != [] - Path to the csv '.rfimodel' file of spectral models for each satellite ID 
+    power_scale: 1.0          # Optional - Fractional scale, of the spectral model, for the satellite emission power 
+##################################
+# TLE trajectory based satellites
+##################################
+  tle_satellite:
+    sat_names: []             # Optional - Names of satellites to include. A 'like' search is done e.g. starlink returns all starlink satellites
+    norad_ids: []             # Optional - NORAD IDs of the satellites to include
+    norad_ids_path: null      # Optional - Path to a file conating the NORAD IDs of satellites to include. Each ID is on a seaprate line
+    norad_spec_model: null    # Required if any TLE satellites are included - Path to the csv file of spectral models fo each satellite by NORAD ID
+    max_n_sat: null           # Optional - Maximum number of TLE satellites to include. Defaults to all found satellites.
+    spacetrack_path: null     # Required if any TLE satellites are included - Path to the Space-Track login config file
+    max_ang_sep: 90           # Optional - Maximum angular separation from the target direction, in degrees, of satellites to include
+    min_alt: 0                # Optional - Minimum altitude of satellites to include. 0 indicates above the horizon
+    tle_dir: ./tles           # Optional - Path to the directory where to save TLEs for future use
+    vis_step: 1.0             # Optional - Time step, in minutes, to check for satellites satisfying the given conditions
+    power_scale: 1.0          # Optional - Fractional scale, of the spectral model, for the satellite emission power 
+##################################################
+# Stationary RFI source relative to the telescope
+##################################################
+  stationary:
+    loc_ids: []               # Optional - IDs of stationary sources to include where the location parameters and spectral models are defined in the following files
+    geo_path: null            # Optional - Path to the (csv) '.loc' file where the stationary sources are positioned
+    spec_model: null          # Required if loc_ids != [] - Path to the csv '.rfimodel' file of spectral models for each stationary source by ID
+    power_scale: 1.0          # Optional - Fractional scale, of the spectral model, for the satellite emission power 
+#######################
+# Telescope parameters
+#######################
+telescope:
+  latitude: null              # Required - Latitude of the telescope location in decimal degrees. North is +ve
+  longitude: null             # Required - Longitude of the telescope in decimal degrees. East from Greenwich meridian
+  elevation: null             # Required - Elevation of the telescope above the WGS84 Earth ellipsoid model in metres.
+  dish_d: null                # Required - Dish diameter in metres
+  enu_path: null              # Required if itrf_path is null - Path to the csv file of the antennas in East, North, Up frame, in metres, relative to the telescope location 
+  itrf_path: null             # Required if enu_path is null - Path to the csv file contaning the antenna positions in International Terrestrial Reference Frame in metres.
+  n_ant: null                 # Required - Number of antennas to include. Takes the forst n_ant antennas in the given antenna files
+  name: MeerKAT               # Optional - Telescope name

tabsim/data/config_files/tab_config_base.yaml

@@ -0,0 +1,86 @@
+##################
+# Data parameters
+##################
+data:
+  sim_dir: null           # Optional - Can be provided when running tabascal   
+  ms_path: null           # Optional - Can be provided when running tabascal 
+  freq: null              # Optional - Defaults to channel 0
+  data_col: DATA          # Optional - Defaults to 'DATA'
+  corr: xx                # Optional - Defaults to 'xx' polarization, i.e. correlation 0
+######################
+# Plotting parameters
+######################
+plots:
+  init: true              # Optional - Plot the estimated astronomical and RFI visibilities as well as the gains based on the initial parameter estimate
+  truth: true             # Optional - Plot the estimated astronomical and RFI visibilities as well as the gains based on the true parameter estimate
+  prior: true             # Optional - Plot the prior distribution over the astronomical and RFI visibilities as well as the gains
+  prior_samples: 100      # Optional - Number of prior samples to use when plotting the prior
+#######################
+# Inference parameters
+#######################
+inference:
+  opt: true               # Optional - Whether to run the optimization to find optimal (MAP) parameters
+  fisher: false           # Optional - Whether to run the Fisher covariance prediction at the optimal (MAP) location found
+  mcmc: false             # Optional - Whether to run MCMC to sample the posterior distribution
+##########################
+# Optimization parameters
+##########################
+opt:
+  epsilon: 1e-2           # Optional - Step size in the optimization run
+  max_iter: 500           # Optional - Maximum number of iterations to run the optimization for
+  guide: map              # Optional - The type of optimization to run. Currently only 'map' is possible
+  dual_run: true          # Optional - Whether to continue optimzation for a second run using a step size 10x smaller
+################################################
+# Fisher-based covariance prediction parameters
+################################################
+fisher:
+  max_cg_iter: 10000     # Optional - Maximum number of conjugate gradient steps to use when when estimating the Fisher-based covariance estimate
+  n_samples: 1           # Optional - Number of samples to use for the Fisher-based covariance estimate 
+###################################################
+# Astronomical prior and initialization parameters
+####################################################
+ast:
+  init: est             # Optional - The initialization method for the astronomical visibility parameters. Options are 'est', 'prior', 'truth', 'truth_mean'
+  mean: 0               # Optional - Mean of the prior distribution for the astronomical visibility parameters. Options are 0, 'est', 'prior', 'truth', 'truth_mean'
+  pow_spec:
+    P0: null            # Optional - Power spectrum value at k=0 for the astronomical visibility parameters prior standard deviation 
+    gamma: 1.0          # Optional - Exponential of the power law section of the power spectrum for astronomical visibility parameters
+    k0: 1e-3            # Optional - Position of the knee of the power spectrum
+##########################################
+# RFI prior and initialization parameters
+##########################################
+rfi:
+  init: est             # Optional - The initialization method for the RFI signal parameters. Options are 'est', 'prior', 'truth'
+  mean: 0               # Optional - Mean of the prior distribution for the astronomical visibility parameters. Options are 0, 'est', 'truth'
+  corr_time: 24         # Optional - Correlation time of the RFI signal in seconds
+  var: null             # Optional - Variance of the RFI signal in Jy. When null an estimate is made based on the data
+  n_int_factor: 1       # Optional - Factor to increase the number of integration samples over the predicted value
+  n_int_samples: null   # Optional - Specify the number of integration samples to use
+############################
+# Satellite path parameters
+############################
+satellites:
+  norad_ids_path: null  # Optional - Path to text file containing NORAD IDs of astellits to include. File should have one NORAD ID per line
+  norad_ids: []         # Optional - NORAD IDs of satellites to include
+  spacetrack_path: null # Required if any TLE satellites are included - Path to the Space-Track login config file
+  tle_dir: null         # Optional - Path of the directory where TLEs will be saved for future runs
+  tle_offset: 0         # Optional - Time offset (in days) for the TLE that is used in tabascal. Specifically for testing 
+  sat_ids: []           # Optional - Satellite IDs of satellites with circular trajectories to include
+  ole_path: null        # Optional - Path to the csv '.ole' file containing circular trajectory-based satellite orbit parameters
+###########################################
+# Gain prior and initialization parameters
+###########################################
+gains:
+  init: prior           # Optional - The initialization method for the gain parameters. Options are 'prior', 'truth'
+  amp_mean: 1.0         # Optional - Mean of the prior distribution over the gain amplitudes. Options are 'truth' or a value like 1.0
+  phase_mean: 0.0       # Optional - Mean of the prior distribution over the gain phases, in radiands. Options are 'truth' or a value like 0.0
+  amp_std: 1.0          # Optional - Standard deviation of the prior distribution over the gain amplitudes as a percentage
+  phase_std: 1.0        # Optional - Standard deviation of the prior distribution over the gain phases in degrees
+  corr_time: 180        # Optional - Correlation time of the gains in minutes
+# ###################
+# # Model parameters
+# ###################
+# model:
+#   func: fixed_orbit_rfi_full_fft_standard_model
+#   name: fixed_orbit_rfi
+