1 of 53

A Guide to using the MeerKAT �Observation Planning Tool (OPT)

Instructions are also available in video format on our �External Service Desk Knowledge Base https://skaafrica.atlassian.net/wiki/spaces/ESDKB/pages/292356390/Observation+Planning+Tool

2 of 53

Getting a SARAO account

Follow the email instructions to obtain your login details��For more information on obtaining a SARAO account please visit:�https://skaafrica.atlassian.net/servicedesk/customer/portal/1/article/333676627

Using the SARAO observation planning tool (OPT) requires a SARAO account. �Register as a first time user at apps.sarao.ac.za/opt/observations���

3 of 53

  • Use the OPT to simulate and plan observations ahead of MeerKAT open time calls to strengthen your proposal or application

  • Users do not require a valid Proposal ID

  • Not having a Proposal ID means that observations can not be submitted

  • However, observations can be saved to return to, and can also be downloaded for future uploads to the OPT
  • Use the OPT to create and submit observations after MeerKAT observing time has been awarded

  • The primary investigator (PI) of a proposal is notified via email of the outcome of the proposal

  • If successful, the email contains a valid Proposal ID (standardly in the format SCI-YYYYMMDD-XX-nn)

  • In the OPT the PI will have access to their associated Proposal IDs. PIs can also provide access to these Proposal IDs to their team members

  • OPT observations with a valid Proposal ID can be submitted to the observing queue for review

Planning vs Submitting with the OPT

The OPT can be used either to plan your MeerKAT observations when writing proposals OR to create observations and submit them to the observing queue when you have been allocated MeerKAT observing time. The differences are highlighted below.

Planning Submitting

4 of 53

Helpful display information

1 . User credentials: After logging in your user credentials appear in the top-right hand corner of the OPT�

1. user credentials

5 of 53

Helpful display information

1 . User credentials: After logging in your user credentials appear in the top-right hand corner of the OPT�

By clicking on the user icon and selecting settings you can review the Proposal IDs � associated with your username:

1. user credentials

In this case the user has not been awarded observing time yet and therefore has no proposals listed.

6 of 53

Helpful display information

1 . User credentials: After logging in your user credentials appear in the top-right hand corner of the OPT�

2. Clocks: At all times the OPT will display, � - current Local Sidereal Time (LST)

- current Universal Standard time (UTC)

- current South African Standard time (SAST)

1. user credentials

2. clocks

7 of 53

Create a new observation

Click on New Observation to create your first observation.��

8 of 53

Create a new observation

In this tutorial we will create a mock observation of the Galaxy Cluster MACS J0025.4-1222.

�The observation will have a total duration of 8 hours (480 min), with:

  • bandpass calibrator scans of 10 min (600 sec) every 3 hours
  • target scans of 30 min (1800 sec) each, and
  • gain calibrator scans of 2 min (120 sec) between each target scan

9 of 53

Create a new observation

In this tutorial we will create a mock observation of the Galaxy Cluster MACS J0025.4-1222.

�The observation will have a total duration of 8 hours (480 min), with:

  • bandpass calibrator scans of 10 min (600 sec) every 3 hours
  • target scans of 30 min (1800 sec) each, and
  • gain calibrator scans of 2 min (120 sec) between each target scan

Note: this tutorial example does not make use of a polarisation calibrator source. �For information on how to add a polarisation calibrator to your observing strategy, please refer to https://skaafrica.atlassian.net/wiki/spaces/ESDKB/pages/1493631000/Polarisation+calibration

10 of 53

Add a description

Step 2: Click on New Observation to create your first observation

Add a description for your Observation, for example,��“Observation of the Galaxy Cluster MACS J0025.4-1222”

11 of 53

Add a description

Step 2: Click on New Observation to create your first observation

If you already have access to a proposal ID or IDs you will be able to select the relevant ID (SCI-YYYYMMDD-XX-nn) from the drop down menu. ��Alternatively, when using the OPT to plan a observation for which observing time has not yet been awarded, you can leave it blank.

12 of 53

Select instrument parameters

Step 2: Click on New Observation to create your first observation

Select the correlator product, integration time and band for the observation.

  1. Correlator products:

��

c856M32k

c - correlator

bc - beamformer

bandwidth in MHz

856M - L-band (centered on 1283 MHz)�544M - U-band (centered on 816 MHz)

number of frequency channels across the band:�32k - 32 768 channels

4k - 4096 channels

1k - 1024 channels

4k_n107M - (narrowband mode)

13 of 53

Select instrument parameters

Step 2: Click on New Observation to create your first observation

Narrowband spectral line mode�When selecting, 4k_n107M, you will be required to enter a center frequency in the range 909.5 MHz to 1658.5 MHz, determined by your scientific interest.�

Narrowband observations are recorded as both a wideband (WB) and narrowband (NB) data product:�

  • WB: 4096 channels across the 856 MHz L-band�
  • NB: 32768 channels across 107 MHz centered on the centre frequency you specified

14 of 53

Select instrument parameters

Select the correlator product, integration time and band for the observation.

2) Integration time:��Options range from 0.25 sec to 8.00 sec, however all integration times < 8.00 sec need to be strongly motivated for in the science case of the submission.��For this tutorial we use the default L-band setup of 4000 channels (c856M4k) �and 8.00 sec integration time. ��

��

15 of 53

Select instrument parameters

Step 2: Click on New Observation to create your first observation

The pool resources are set to cbf, sdp by default.

�These resources are required for all science observations,

  • cbf: correlator and/ beamformer
  • sdp: science data processing.

Additional commensal resources and user supplied equipment (USEs) can be added to this list for particular use cases. Note this can only be done if the advanced button is toggled.

16 of 53

Configure an observing block

This pattern, with gaincal* scans on either side of target scans, is �repeated every ~ 3 hrs until the required observing duration is reached

*gaincal = Gain calibrator

**bpcal = Bandpass calibrator

Observations typically follow the format,

the bpcal** is repeated every 3 hrs, and typically observed at the start and end of an observation.

Bpcal

Gaincal

Target

Gaincal

Target

Bpcal

Gaincal

… …

17 of 53

Configure an observing block

Observations typically follow the format,

  • The use of Blocks allows you to easily create observations �with such repeating patterns
  • Click on Configure to create the first observing block within the observation

Bpcal

Gaincal

Target

Gaincal

Target

Bpcal

Gaincal

… …

18 of 53

Import observing targets

Click on Import Sources to add the target/s that you want to observe. � � � A pop-up box, to set the target duration will appear.� The default target scan is 1800 seconds or 30 min. � We will use this default value.

19 of 53

Import observing targets

Add the target/s you want to observe by clicking on Import and upload a csv file with the target coordinates in the following format,

# Name, radec tag, RA(J2000), Dec(J2000)

J0025-1222, radec target,00:25:29.381,-12:22:37.06�You will be able to select calibrators (bpcal and gaincal) �from the planning tool.

20 of 53

Import observing targets

The target and its RA/DEC J2000 coordinates appear, labelled as target with an associated track of 1800 sec.

Notice that the start of the LST observing window is automatically populated with LST time the sources rises above the horizon, which by default is at (its minimum value of) 15 degrees. �You will be able to adjust desired LST starting windows, as well as selected horizon values as you continue planning your observation. Note that horizon values larger than 15 degrees will need to be strongly motivated for in the science case of the submission.

21 of 53

Add a gain calibrator

�Click on to choose a gain calibrator to use with the imported target

22 of 53

Add a gain calibrator

�Click on to choose a gain calibrator to use with the imported target

�The elevation plot shows useable gain calibrators to choose from for the imported target.

Coordinates and separation to target are shown for each gain calibrator in the list

23 of 53

Add a gain calibrator

�Click on to choose a gain calibrator to use with the imported target

For this example we choose J0025-0014 that is always above the horizon when the target is up

Use + to add the gain calibrator

Click here to view the full SARAO gain calibrators database

24 of 53

Add a gain calibrator

�Click on to choose a gain calibrator to use with the imported target

The gain calibrator observing duration is set to 120 sec (2 minutes).

�This is sufficient for all gain calibrators listed in the SARAO gain calibrator database and the default suggested value in the OPT.

The source will by default receive the tag gaincal.��

25 of 53

Inspect elevation plot

�Click on to choose a gain calibrator to use with the imported target

At any point you can click on to view the elevation plot of the sources included in the observation so far.

26 of 53

Inspect elevation plot

The elevation plot shows our target source is up between LST 19:07 and LST 05:43 �when using the default (and minimum) horizon level of 15 degrees.��

Corresponding UTC times for today are shown along the top axis.

27 of 53

Inspect elevation plot

The elevation plot shows our target source is up between LST 19:07 and LST 05:43 �when using the default (and minimum) horizon level of 15 degrees.��

Corresponding UTC times for today are shown along the top axis.

The LST start and end range is the window in which the observation �can be started.��It is a compulsory field. ��For an 8 hr track �on target, the LST end range is therefore �~ 8 hrs before LST 05:43.�We set it to 21:30.��The LST end range can be adapted throughout the observing planning.

Close the plot by clicking on x

28 of 53

Inspect observing layout

�Notice the LST range in Observation Parameters has been populated. ��Having completed this last compulsory field allows you to save the observation.

�Next we can return to Block view to inspect the observing layout.

29 of 53

Inspect the observing layout

This block will currently be observed once (Repeats = 1) , and will have duration of 32 min (30 min on target, 2 min on gaincal).�

The block we created contains two sources (target and gaincal).

We can rename the block to, e.g. Gaincal-Target.��

Note: After clicking Save for the first time the OPT Id field is populated;�and the Simulate and Submit buttons are activated. �The OPT entry can be saved continuously as changes are made.

30 of 53

Add a bandpass calibrator

Recall the standard observing pattern,

We require a bandpass calibrator to be repeated every 3 hrs. �Add a block for the Bpcal by clicking on add Block and rename it to e.g. Bpcal.

repeat every ~ 3 hrs until the observing duration is reached

Bpcal

Gaincal

Target

Gaincal

Target

Bpcal

Gaincal

… …

31 of 53

Add a bandpass calibrator

The order of Blocks can be rearranged by clicking and dragging the full block.

�We move the Bpcal block to the front, and click �on Configure to set up the bandpass calibrator source.

click and drag

32 of 53

Add a bandpass calibrator

Click on Flux & Bandpass calibrator to add a bpcal

An elevation plot showing MeerKAT’s three bandpass calibrator sources will appear, they are

J0408-6545 | PKS 0408-658

J1331+3030 | 3C286

J1939-6342 | PKS 1939-6342

33 of 53

Add a bandpass calibrator

Choose the best bpcal for the observation based on your target LST range.�

Our target is up from LST 19:07 to 05:43, we therefore firstly select J1939-6342 by clicking +.

34 of 53

Add a bandpass calibrator

The Bpcal by default receives tags delaycal, fluxcal, bpcal.

The default bpcal observing duration is 600 sec (10min).

35 of 53

Build an observing unit to repeat

Navigating back to the Block view, we build out the observing strategy. ���

Existing blocks can be duplicated using the select and Copy function, as illustrated here by copying the Gaincal-Target block.

36 of 53

Build an observing unit to repeat

Recall our observing strategy, ���

repeat every ~ 3 hrs until the observing duration is reached

To complete a single repeating unit we therefore remove the target scan from the last block, and rename it to Gaincal. ��

Bpcal

Gaincal

Target

Gaincal

Target

Gaincal

Bpcal

37 of 53

Build an observing unit to repeat

Click on Configure to enter the block. Select the target scan from this last block, and click on to remove it.��

Returning to Block view the block only contains one source. We rename it to Gaincal.��

observing unit to be repeated every ~ 3 hrs

Total observing time 44 min

38 of 53

Build an observing unit to repeat

Increasing the repeats to 5 on the Gaincal-Target block,

provides an observing unit of ~ 3hrs.

��

Observing unit to be repeated every ~ 3 hrs

After saving these changes, we can simulate the observation. ��

39 of 53

Simulate the observation

To start the simulation a UTC time and date is requested. ��By default it will be the UTC time for the current day corresponding to the LST start time (here LST 19:07). Thereafter it will default to the simulation UTC date and time most recently used. �

40 of 53

Simulate the observation

Return to the source list and block view, �by clicking on

��

The simulation produces,

2. a source elevation vs time plot,

1. an observing log,

3. an observing duration per source summary at the end of the log.

41 of 53

Complete the observing track

Select all and copy, allows you to repeat this observing unit, ��until we reach a duration closer to our intended observing track of 8 hrs.

��

42 of 53

Complete the observing track

Finally add a BPcal at the end by copying, the Bpcal block.��

��

We also reduce the repetitions on two Gaincal-Target blocks to ensure the observation duration is below our intended 8hrs.��Save and simulate to inspect the final result. �

43 of 53

Simulate the full observation

Simulate the observation for the a UTC time and date corresponding to the end of the LST-window provided (here LST 21:30). �Recall, the elevation plot provides these mappings easily. ��This is to ensure that the observation is valid for the full LST-window provided before submitting it. �

44 of 53

Simulate the full observation

�Note: The output log warns that the bpcal has set when its last scan is reached!

To solve the issue of the setting bandpass calibrator, ��1) either exchange the last bpcal scan for another bpcal source

�2) or adapt the LST-window range. ��We encourage larger LST ranges, as it allows greater flexibility in scheduling.

45 of 53

Simulate the full observation

Using the same procedures as before configure the last Bpcal. ��Delete J1939-6342 from the block and instead add J0408-6545 as a bpcal. �Rename the block for reference.

46 of 53

Simulate the full observation

�J0408-6545 is successfully used as the bpcal on the last bpcal scan. No other warning messages.

47 of 53

Simulate the full observation

�The total observing time here includes all slew times as can be seen from the simulation log output text. Ensure that this total observing time is less than your planned or awarded observing time.

478.65 min

= 7.98 hrs ≲ 8 hrs

48 of 53

Observation as a JSON

Text formats of the observation is stored at . . ��In particular the JSON file capturing this observation can easily be downloaded for your record.��You may also choose to upload a correctly formatted json to create your observation entry. ��

49 of 53

Observation as a JSON

Text formats of the observation is stored at . . ��In particular the JSON file capturing this observation can easily be downloaded for your record.��You may also choose to upload a correctly formatted json to create your observation entry. ��

If you are using the OPT to plan your observation, and do not have a Proposal ID, we highly recommend that you download the json for your own reference and for future uploads to the OPT.

50 of 53

Specify additional observing setups

Add any additional observation requirements under Observation Setup at .. This includes:

  • Night time requests
  • Avoiding Sunrise/sunset
  • Avoiding and or preferring particular dates
  • Baseline requirements
  • Minimum number of required antennas (max 58)

all additional requests should be strongly motivated in your submitted proposal

51 of 53

Submit the observation

Save your observation to return to at a later stage.

Or if you ready and if you have a valid Proposal ID, you can submit the observation for review!

52 of 53

Support

For additional information on the OPT please visit the SARAO service desk pages at �

https://skaafrica.atlassian.net/wiki/spaces/ESDKB/pages/292356390/Observation+Planning+Tool

If you require any technical support with your SARAO account or using the OPT,�please raise a helpdesk ticket at

https://skaafrica.atlassian.net/servicedesk/customer/portals

and remember to quote your Proposal ID (if available) or username in the query.

CAPE TOWN Tel: +27 (0)21 506 7300 | 2 Fir Street, Black River Park | Observatory, Cape Town | South Africa 7925

HARTEBEESTHOEK Tel: +27 (12) 301 3100 l Farm 502 JQ, Hartebeesthoek, Broederstroom Road, Hartebeesthoek, 1740

53 of 53

Video and presentation by Marisa Geyer

Image credits: SARAO