ACISpy Command Line Tools¶
For making quick plots and getting quick summaries of important information, the following ACISpy-based command-line utilities are provided. For finer-grained control over plots and data, it is recommended to use the ACISpy Python interface.
Activating¶
The ACISpy command-line tools are installed into the ACIS Ops Ska Python stack.
If you are logged on as acisdude, all you need to do is issue the
command acisska and this Python stack and the tools will be loaded into
your environment.
However, if you would like activate this stack and these tools from your own user
account, add the following alias to your .bashrc if you are using the Bash
shell (or a variant):
alias acisska='eval "$(/data/acis/miniconda3/bin/conda shell.bash hook)"; \
export SKA=/proj/sot/ska; \
conda activate ska'
Or, if you are a mascohist or are otherwise compelled to use the C shell or a
variant of it, add this alias to your .cshrc.user:
alias acisska 'source /data/acis/miniconda3/etc/profile.d/conda.csh; \
setenv SKA /proj/sot/ska; \
conda activate ska'
Warning
The ACIS Ops Ska Python stack should be used in a “clean” terminal window where you are not trying to do anything else (i.e., load reviews, SACGS) as setting up the Ska environment messes with environment variables and paths.
multiplot_archive¶
usage: multiplot_archive [-h] [--one-panel] [--maude] tstart tstop plots
Make plots of MSIDs and commanded states from the engineering archive
positional arguments:
tstart The start time in YYYY:DOY:HH:MM:SS format
tstop The stop time in YYYY:DOY:HH:MM:SS format
plots The MSIDs and states to plot, comma-separated
optional arguments:
-h, --help show this help message and exit
--one-panel Whether to make a multi-panel plot or a single-panel plot. The
latter is only valid if the quantities have the same units.
--maude Use MAUDE to get telemetry data.
multiplot_tracelog¶
usage: multiplot_tracelog [-h] [--one-panel] tracelog plots
Make plots of MSIDs from a tracelog file. Commanded states will be loaded from
the commanded states database.
positional arguments:
tracelog The tracelog file to load the MSIDs from
plots The MSIDs and states to plot, comma-separated
optional arguments:
-h, --help show this help message and exit
--one-panel Whether to make a multi-panel plot or a single-panel plot. The
latter is only valid if the quantities have the same units.
Example 2¶
[~]$ multiplot_tracelog acisENG10d_00985114479.70.tl 1dp28avo,1dp28bvo --one-panel
Returns:
plot_10day_tl¶
usage: plot_10day_tl [-h] [--days DAYS] [--one-panel] fields
Plot one or more MSIDs or states from the ACIS 10-day tracelog files.
positional arguments:
fields The MSIDs and states to plot, comma-separated
optional arguments:
-h, --help show this help message and exit
--days DAYS The number of days before the end of the log to plot. Default:
10
--one-panel Whether to make a multi-panel plot or a single-panel plot. The
latter is only valid if the quantities have the same units.
Example 1¶
Plot one MSID and two states in three different panels.
[~]$ plot_10day_tl 1pdeaat,pitch,off_nom_roll
Returns:
Example 2¶
Plot 3 MSIDs from ove the past three days and combine them in one panel.
[~]$ plot_10day_tl 1dpamzt,tmp_fep1_mong,tmp_bep_pcb --days 3 --one-panel
Returns:
plot_model¶
usage: plot_model [-h] [--y2_axis Y2_AXIS] load y_axis
Plot a single model component with another component or state
positional arguments:
load The load to take the model from
y_axis The model component to plot on the left y-axis
optional arguments:
-h, --help show this help message and exit
--y2_axis Y2_AXIS The model component or state to plot on the right y-axis
(default: none)
plot_msid¶
usage: plot_msid [-h] [--y2_axis Y2_AXIS] [--maude] tstart tstop y_axis
Plot a single MSID with another MSID or state
positional arguments:
tstart The start time in YYYY:DOY:HH:MM:SS format
tstop The stop time in YYYY:DOY:HH:MM:SS format
y_axis The MSID to be plotted on the left y-axis
optional arguments:
-h, --help show this help message and exit
--y2_axis Y2_AXIS The MSID or state to be plotted on the right y-axis
(default: none)
--maude Use MAUDE to get telemetry data.
simulate_ecs_run¶
usage: simulate_ecs_run [-h] [--dh_heater DH_HEATER] [--instrument INSTRUMENT] component tstart hours T_init attitude ccd_count
Simulate an ECS run.
positional arguments:
component The component to model: dpa, dea, psmc, or acisfp
tstart The start time of the ECS run in YYYY:DOY:HH:MM:SS format
hours The length of the ECS run in hours.
T_init The initial temperature of the component in degrees C.
attitude The attitude information for the ECS run. One of three possible formats: pitch,off_nom_roll: 155.0,2.0;
quaternion: 1.0,0.3,0.0,0.0; vehicle_load: SEP1921C
ccd_count The number of CCDs to clock.
optional arguments:
-h, --help show this help message and exit
--dh_heater DH_HEATER
Is the DH heater on (1) or off (0)? Default: 0/off.
--instrument INSTRUMENT
Which instrument will be used to conduct the ECS measurement, ACIS-I or ACIS-S. Required for runs with the
focal plane model.
Example 1¶
To run the 1DPAMZT model with the following conditions:
Start time: 2015:100:12:45:30
Length of ECS run: 24 hours
Initial temperature: 10.0 degrees C
Pitch: 150 degrees
CCD count: 6
Off-nominal roll: 12.0 degrees
[~]$ simulate_ecs_run dpa 2015:100:12:45:30 24 10.0 150.0,12.0 6
Returns:
acispy: [INFO ] 2021-12-10 13:34:17,872 Using model for dpa from chandra_models version = 3.37
Fetching msid: aoeclips over 2015:100:12:22:16.816 to 2015:102:05:16:48.816
acispy: [INFO ] 2021-12-10 13:34:18,213 Run Parameters
acispy: [INFO ] 2021-12-10 13:34:18,213 --------------
acispy: [INFO ] 2021-12-10 13:34:18,213 Modeled Temperature: 1dpamzt
acispy: [INFO ] 2021-12-10 13:34:18,213 Start Datestring: 2015:100:12:45:30.000
acispy: [INFO ] 2021-12-10 13:34:18,214 Length of state in hours: 24.0
acispy: [INFO ] 2021-12-10 13:34:18,214 Stop Datestring: 2015:102:04:55:48.000
acispy: [INFO ] 2021-12-10 13:34:18,214 Initial Temperature: 10.0 degrees C
acispy: [INFO ] 2021-12-10 13:34:18,214 CCD/FEP Count: 6
acispy: [INFO ] 2021-12-10 13:34:18,214 Pitch: 150.0
acispy: [INFO ] 2021-12-10 13:34:18,214 Off-nominal Roll: 12.0
acispy: [INFO ] 2021-12-10 13:34:18,214 Detector Housing Heater: OFF
acispy: [INFO ] 2021-12-10 13:34:18,215 Model Result
acispy: [INFO ] 2021-12-10 13:34:18,215 ------------
acispy: [INFO ] 2021-12-10 13:34:18,217 The limit of 37.5 degrees C will be reached at 2015:100:19:17:44.816, after 23.53481599998474 ksec.
acispy: [INFO ] 2021-12-10 13:34:18,217 The limit is reached before the end of the observation.
acispy: [WARNING ] 2021-12-10 13:34:18,217 This observation is NOT safe from a thermal perspective.
acispy: [INFO ] 2021-12-10 13:34:19,013 Image of the model run has been written to ecs_run_1dpamzt_6chip_2015:100:12:45:30.png.
Example 2¶
To run the ACIS focal plane model with the following conditions:
Start time: 2020:148:14:45:00
Length of ECS run: 24 hours
Initial temperature: -115.0 degrees C
Quaternion: [-0.04470333, 0.63502552, -0.67575906, 0.37160988]
CCD count: 4
Instrument: ACIS-S
Note that in this case we specify an attitude quaternion for an accurate representation of the Earth solid angle. We must also specify an instrument.
[~]$ simulate_ecs_run acisfp 2020:148:14:45:00 24 -115.0 -0.04470333,0.63502552,-0.67575906,0.37160988 4 --instrument=ACIS-S
Returns:
acispy: [INFO ] 2021-12-10 13:31:56,940 Using model for acisfp from chandra_models version = 3.37
Fetching msid: aoeclips over 2020:148:14:22:22.816 to 2020:150:07:16:54.816
acispy: [INFO ] 2021-12-10 13:31:58,566 Run Parameters
acispy: [INFO ] 2021-12-10 13:31:58,566 --------------
acispy: [INFO ] 2021-12-10 13:31:58,566 Modeled Temperature: fptemp_11
acispy: [INFO ] 2021-12-10 13:31:58,566 Start Datestring: 2020:148:14:45:00.000
acispy: [INFO ] 2021-12-10 13:31:58,566 Length of state in hours: 24.0
acispy: [INFO ] 2021-12-10 13:31:58,566 Stop Datestring: 2020:150:06:55:18.000
acispy: [INFO ] 2021-12-10 13:31:58,566 Initial Temperature: -115.0 degrees C
acispy: [INFO ] 2021-12-10 13:31:58,566 CCD/FEP Count: 4
acispy: [INFO ] 2021-12-10 13:31:58,566 Quaternion: [-0.04470333, 0.63502552, -0.67575906, 0.37160988]
acispy: [INFO ] 2021-12-10 13:31:58,566 Pitch: 155.13828486037553
acispy: [INFO ] 2021-12-10 13:31:58,566 Off-nominal Roll: 10.637704660891393
acispy: [INFO ] 2021-12-10 13:31:58,566 Detector Housing Heater: OFF
acispy: [INFO ] 2021-12-10 13:31:58,568 Model Result
acispy: [INFO ] 2021-12-10 13:31:58,568 ------------
acispy: [INFO ] 2021-12-10 13:31:58,569 The focal plane is never cold for this ECS measurement.
acispy: [INFO ] 2021-12-10 13:31:58,570 The limit of -111.0 degrees C will be reached at 2020:149:06:02:38.816, after 55.058815999984745 ksec.
acispy: [INFO ] 2021-12-10 13:31:58,571 The limit is reached before the end of the observation.
acispy: [INFO ] 2021-12-10 13:31:59,331 Image of the model run has been written to ecs_run_fptemp_11_4chip_2020:148:14:45:00.png.
Example 3¶
This example assumes that the vehicle loads are still running, which means that the attitude information comes from a load.
To run the 1DPAMZT model with the following conditions:
Start time: 2017:256:03:20:00
Length of ECS run: 24 hours
Initial temperature: 10.0 degrees C
CCD count: 6
Vehicle load: SEP0917C
[~]$ simulate_ecs_run dpa 2017:256:03:20:00 24 10.0 SEP0917C 6
Returns:
acispy: [INFO ] 2021-12-10 13:35:11,194 Modeling a 6-chip state concurrent with the SEP0917C vehicle loads.
acispy: [INFO ] 2021-12-10 13:35:13,604 Using model for dpa from chandra_models version = 3.37
Fetching msid: aoeclips over 2017:256:02:54:54.816 to 2017:257:19:49:26.816
acispy: [INFO ] 2021-12-10 13:35:13,984 Run Parameters
acispy: [INFO ] 2021-12-10 13:35:13,984 --------------
acispy: [INFO ] 2021-12-10 13:35:13,984 Modeled Temperature: 1dpamzt
acispy: [INFO ] 2021-12-10 13:35:13,984 Start Datestring: 2017:256:03:20:00.000
acispy: [INFO ] 2021-12-10 13:35:13,984 Length of state in hours: 24.0
acispy: [INFO ] 2021-12-10 13:35:13,984 Stop Datestring: 2017:257:19:30:18.000
acispy: [INFO ] 2021-12-10 13:35:13,984 Initial Temperature: 10.0 degrees C
acispy: [INFO ] 2021-12-10 13:35:13,984 CCD/FEP Count: 6
acispy: [INFO ] 2021-12-10 13:35:13,985 Detector Housing Heater: OFF
acispy: [INFO ] 2021-12-10 13:35:13,986 Model Result
acispy: [INFO ] 2021-12-10 13:35:13,986 ------------
acispy: [INFO ] 2021-12-10 13:35:13,990 The limit of 37.5 degrees C will be reached at 2017:256:11:34:14.816, after 29.65481599998474 ksec.
acispy: [INFO ] 2021-12-10 13:35:13,990 The limit is reached before the end of the observation.
acispy: [WARNING ] 2021-12-10 13:35:13,990 This observation is NOT safe from a thermal perspective.
acispy: [INFO ] 2021-12-10 13:35:15,138 Image of the model run has been written to ecs_run_1dpamzt_6chip_2017:256:03:20:00.png.
phase_scatter_plot¶
usage: phase_scatter_plot [-h] [--c_field C_FIELD] [--cmap CMAP] [--maude]
tstart tstop x_field y_field
Make a phase scatter plot of one MSID or state versus another within a certain
time frame.
positional arguments:
tstart The start time in YYYY:DOY:HH:MM:SS format
tstop The stop time in YYYY:DOY:HH:MM:SS format
x_field The MSID or state to plot on the x-axis
y_field The MSID or state to plot on the y-axis
optional arguments:
-h, --help show this help message and exit
--c_field C_FIELD The MSID or state to plot using colors
--cmap CMAP The colormap to use if plotting colors
--maude Use MAUDE to get telemetry data.
Example 2¶
[~]$ phase_scatter_plot 2017:100 2017:200 1deamzt 1dpamzt --c_field ccd_count --cmap=jet
Returns:
phase_histogram_plot¶
usage: phase_histogram_plot [-h] [--scale SCALE] [--cmap CMAP] [--maude]
tstart tstop x_field y_field x_bins y_bins
Make a phase plot of one MSID or state versus another within a certain time
frame.
positional arguments:
tstart The start time in YYYY:DOY:HH:MM:SS format
tstop The stop time in YYYY:DOY:HH:MM:SS format
x_field The MSID or state to plot on the x-axis
y_field The MSID or state to plot on the y-axis
x_bins The number of bins on the x-axis
y_bins The number of bins on the y-axis
optional arguments:
-h, --help show this help message and exit
--scale SCALE Use linear or log scaling for the histogram, default 'linear'
--cmap CMAP The colormap for the histogram, default 'hot'
--maude Use MAUDE to get telemetry data.
Example¶
[~]$ phase_histogram_plot 2017:100 2017:200 1deamzt 1dpamzt 40 40 --scale=log --cmap=hsv
Returns:
