PAN-78 Small refactor. Interface for custom telescope arrays has been moved into the yaml configs. Custom code has been moved out of reports.py

Author: sstansill

data/yaml/all_custom_options.yml

@@ -114,19 +114,19 @@ Tint_out: 1.4
 # DPrepD: Tint_min
 
 tRCAL_G: 10.0
-# Real time solution interval for antenna gains
+# Real time solution interval for antenna gains *s*
 
 
 tICAL_G: 1.0 
-# Solution interval for antenna gains
+# Solution interval for antenna gains *s*
 
 
 tICAL_B: 3600.0
-# Solution interval for Bandpass
+# Solution interval for Bandpass *s*
 
 
 tICAL_I: 10.0
-# Solution interval for Ionosphere
+# Solution interval for Ionosphere *s*
 
 
 NIpatches: 1
@@ -186,6 +186,9 @@ Ntiedbeam: 1500
 # SKA_Low: 500
 # PST: 16
 
+Qfov: 2.7 
+# Field of view quotient
+
 
 on_the_fly: False
 
@@ -257,3 +260,11 @@ Npatch: 4097 # Number of pixels in clean patch
 Tsolve: 600 # Calibration solution process frequency (task granularity)
 Tsnap_min: 0.1
 Tsnap: 600
+
+
+array_config_file: '../data/layouts/SKA1_Mid_rev_05_prop.txt' 
+# If specified, baseline_bins and baseline_bin_distribution will be overwritten. If specified, array_config_bins nust also be specified
+
+array_config_bins: 12
+# Number of baseline bins to be used when calculating the histogram of baselines. 
+# Increasing the number of bins slows down the parametric model

data/yaml/hpso_max_mid_band1_ICal.yml

@@ -2,7 +2,7 @@ name: 'max_mid_band1'
 telescope: 'SKA1_Mid'
 band: 'Mid1'
 pipeline: 'ICAL' # One of ['Ingest', 'RCAL', 'FastImg', 'ICAL', 'DPrepA', 'DPrepA_Image', 'DPrepB', 'DPrepC', 'DPrepD', 'PSS', 'PST', 'SinglePulse']
-Bmax: 150000  # Actually constructed max baseline in *m*
+Bmax: 149000.0  # Actually constructed max baseline in *m*
 Ds: 13.5  # dish diameter in metres, assume 13.5 as this matches the MeerKAT dishes
 Na: 197 # number of dishes (sum of MeerKAT and new dishes)
 Nbeam: 1  # number of beams
@@ -18,7 +18,7 @@ Texp: 21600
 # Baseline length distribution calculated from layout in
 # SKA-TEL-SKO-0000422, Rev 03 (corresponding to ECP-170049),
 # see Absolute_Baseline_length_distribution.ipynb
-baseline_bins: [5000.0, 7500.0, 10000.0, 15000.0, 25000.0, 35000.0, 55000.0, 75000.0, 90000.0, 110000.0, 130000.0, 150000.0]
+baseline_bins: [1.0, 7500.0, 10000.0, 15000.0, 25000.0, 35000.0, 55000.0, 75000.0, 90000.0, 110000.0, 130000.0, 150000.0]
 baseline_bin_distribution: [61.3646961, 5.16553546, 2.87031760, 4.98937879,
             6.32609709, 4.63706544, 5.73545412, 5.50230558,
             1.80301539, 1.45070204, 0.108802653, 0.0466297083]
@@ -30,4 +30,11 @@ tICAL_G: 1.0 # Solution interval for Antenna gains
 tICAL_B: 3600.0  # Solution interval for Bandpass
 tICAL_I: 10.0 # Solution interval for Ionosphere
 NIpatches: 1 # Number of ionospheric patches to solve
-Qfov: 2.7
+Qfov: 2.7
+
+array_config_file: '../data/layouts/SKA1_Mid_rev_02.txt' 
+# If specified, baseline_bins and baseline_bin_distribution will be overwritten. If specified, array_config_bins nust also be specified
+
+array_config_bins: 10
+# Number of baseline bins to be used when calculating the histogram of baselines. 
+# Increasing the number of bins slows down the parametric model

notebooks/SKA1_Export.ipynb

@@ -82,7 +82,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "yml_path = os.path.join('..','data','yaml','')\n",
+    "yml_path = os.path.join('..', 'data','yaml','')\n",
     "\n",
     "# Change to get date+git version, etc\n",
     "outfile = csv_path + 'custom_pipelines.csv'\n",
@@ -93,9 +93,8 @@
     "for infile in infile_names:\n",
     "    infile_paths.append(yml_path + infile)\n",
     "\n",
-    "custom_arrays = [False, False, False, False]\n",
     "\n",
-    "reports.write_csv_custom(infile_paths, outfile, custom_arrays, parallel=parallel, verbose=False)\n"
+    "reports.write_csv_custom(infile_paths, outfile, parallel=parallel, verbose=False)\n"
    ]
   },
   {
@@ -111,19 +110,10 @@
     "infile_names = ['all_custom_options.yml', 'hpso_max_mid_band1_ICal.yml', 'hpso01_DPrepD.yml', 'hpso01_ICal.yml']\n",
     "\n",
     "infile_paths = []\n",
-    "custom_arrays = []\n",
     "for infile in infile_names:\n",
     "    infile_paths.append(yml_path + infile)\n",
     "\n",
-    "custom_arrays = [True, False, False, False]\n",
-    "\n",
-    "# array_configs and list_num_bins:\n",
-    "# Must be the same length as len(np.where(custom_arrays)[0])\n",
-    "# Must be ordered (ie first array_config corresponds to the first infile with custom_array == True\n",
-    "array_configs = ['SKA1_Mid_rev_05_prop.txt']\n",
-    "list_num_bins = [12]\n",
-    "\n",
-    "reports.write_csv_custom(infile_paths, outfile, custom_arrays, array_configs, list_num_bins, parallel=parallel, verbose=False)\n"
+    "reports.write_csv_custom(infile_paths, outfile, parallel=parallel, verbose=False)\n"
    ]
   },
   {
@@ -137,7 +127,7 @@
     "# Change to get date+git version, etc\n",
     "outfile = csv_path + 'custom_max_mid_band1.csv'\n",
     "prefix = 'reduced_max_mid_band1/hpso_max_mid_band1_'\n",
-    "pipelines = ['Ingest', 'RCal', 'FastImg', 'ICal', 'DPrepA', 'DPrepB', 'DPrepC']\n",
+    "pipelines = ['Ingest', 'RCAL', 'FastImg', 'ICAL', 'DPrepA', 'DPrepB', 'DPrepC']\n",
     "suffix = '.yml'\n",
     "\n",
     "infile_names = []\n",
@@ -146,13 +136,11 @@
     "    infile_names.append(prefix + pipeline + suffix)\n",
     "\n",
     "infile_paths = []\n",
-    "custom_arrays = []\n",
     "\n",
     "for infile in infile_names:\n",
     "    infile_paths.append(yml_path + infile)\n",
-    "    custom_arrays.append(False)\n",
     "\n",
-    "reports.write_csv_custom(infile_paths, outfile, custom_arrays, parallel=parallel, verbose=False)"
+    "reports.write_csv_custom(infile_paths, outfile, parallel=parallel, verbose=False)"
    ]
   },
   {
@@ -166,7 +154,7 @@
     "# Change to get date+git version, etc\n",
     "outfile = csv_path + 'max_mid_band1.csv'\n",
     "prefix = 'max_mid_band1/hpso_max_mid_band1_'\n",
-    "pipelines = ['Ingest', 'RCal', 'FastImg', 'ICal', 'DPrepA', 'DPrepB', 'DPrepC']\n",
+    "pipelines = ['Ingest', 'RCAL', 'FastImg', 'ICAL', 'DPrepA', 'DPrepB', 'DPrepC']\n",
     "suffix = '.yml'\n",
     "\n",
     "infile_names = []\n",
@@ -175,13 +163,11 @@
     "    infile_names.append(prefix + pipeline + suffix)\n",
     "\n",
     "infile_paths = []\n",
-    "custom_arrays = []\n",
     "\n",
     "for infile in infile_names:\n",
     "    infile_paths.append(yml_path + infile)\n",
-    "    custom_arrays.append(False)\n",
     "\n",
-    "reports.write_csv_custom(infile_paths, outfile, custom_arrays, parallel=parallel, verbose=False)"
+    "reports.write_csv_custom(infile_paths, outfile, parallel=parallel, verbose=False)"
    ]
   },
   {
@@ -198,7 +184,7 @@
     "prefix_1 = 'reduced_max_mid_band1/hpso_max_mid_band1_'\n",
     "prefix_2 = 'reduced_hpso_4b/hpso_4b_'\n",
     "\n",
-    "pipelines_1 = ['Ingest', 'RCal', 'FastImg', 'ICal', 'DPrepA', 'DPrepB', 'DPrepC']\n",
+    "pipelines_1 = ['Ingest', 'RCAL', 'FastImg', 'ICAL', 'DPrepA', 'DPrepB', 'DPrepC']\n",
     "pipelines_2 = ['Ingest', 'RCAL', 'PSS', 'FastImg']\n",
     "\n",
     "suffix = '.yml'\n",
@@ -212,13 +198,11 @@
     "    infile_names.append(prefix_2 + pipeline + suffix)\n",
     "\n",
     "infile_paths = []\n",
-    "custom_arrays = []\n",
     "\n",
     "for infile in infile_names:\n",
     "    infile_paths.append(yml_path + infile)\n",
-    "    custom_arrays.append(False)\n",
     "\n",
-    "reports.write_csv_custom(infile_paths, outfile, custom_arrays, parallel=parallel, verbose=False)"
+    "reports.write_csv_custom(infile_paths, outfile, parallel=parallel, verbose=False)"
    ]
   },
   {

notebooks/SKA1_Imaging_Performance_Model.ipynb

@@ -60,9 +60,9 @@
    "source": [
     "## Compute requirements for a custom telescope and pipeline configuration\n",
     "\n",
-    "A yaml file needs to be created that contains the custom telescope observation attributes. Examples are provided in the /data/yaml/ directory. The output verbosity also needs to be set.\n",
+    "A yaml file needs to be created that contains the custom telescope observation attributes. Examples are provided in the `/data/yaml/` directory. The output verbosity also needs to be set.\n",
     "\n",
-    "A custom telescope array configuration can be used by creating a txt file that contains each antenna's latitude and longitude coordinates - `custom_array` must be set to True in this case. Examples are provided in the /data/ayouts/ directory. A baseline histogram is created from the antenna positions to simplify calculations and `num_bins` can be used to set the number of histogram bins used.\n",
+    "A custom telescope array configuration can be used by creating a txt file that contains each antenna's latitude and longitude coordinates - `array_config_file` must be set in the yaml file to use a custom telescope array. Example layout files are provided in the `/data/layouts/` directory. A baseline histogram is created from the antenna positions to simplify calculations and `array_config_bins` must be specified in the yaml which sets the number of histogram bins used. More bins makes the parametric model slower.\n",
     "\n",
     "Once the object is created, the `run` method can be called to compute the requirements. There's no interactive mode for this case."
    ]
@@ -73,11 +73,32 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "app = reports.CustomObservation(\n",
-    "    yaml_file=\"../data/yaml/hpso_max_mid_band1_ICal.yml\",\n",
-    "    custom_array=True,\n",
-    "    array_txt_file=\"../data/layouts/SKA1_Mid_rev_02.txt\",\n",
-    "    num_bins=10,\n",
+    "app = reports.Observation(\n",
+    "    use_yaml=True,\n",
+    "    yaml_path=\"../data/yaml/hpso_max_mid_band1_ICal.yml\",\n",
+    "    verbose='Overview',\n",
+    ")\n",
+    "app.run()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Compute requirements for a hard-coded HPSO\n",
+    "\n",
+    "The following cell shows the Observation class being used with a specified HPSO, rather than a custom observation without an interactive interface."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "app = reports.Observation(\n",
+    "    pipeline='Ingest',\n",
+    "    hpso='hpso04b',\n",
     "    verbose='Overview',\n",
     ")\n",
     "app.run()"
@@ -150,7 +171,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.18"
+   "version": "3.11.5"
   }
  },
  "nbformat": 4,