Actor commands#

The hal actor replies to the following commands.

hal#

hal [OPTIONS] COMMAND [ARGS]...

bypass#

Enable/disable bypasses.

hal bypass [OPTIONS] COMMAND [ARGS]...

disable#

Disabless a series of bypasses

hal bypass disable [OPTIONS] [BYPASSES]...

Arguments

BYPASSES#

Optional argument(s)

enable#

Enables a series of bypasses

hal bypass enable [OPTIONS] [BYPASSES]...

Arguments

BYPASSES#

Optional argument(s)

calibrations#

Performs camera and telescope calibrations.

hal calibrations [OPTIONS] COMMAND [ARGS]...

apogee-dome-flat#

Runs the APOGEE dome flat sequence.

hal calibrations apogee-dome-flat [OPTIONS]

Options

--list-stages#

List the stages for this macro.

-s, --stages <stages>#

Comma-separated list of stages to execute.

expose#

Take science exposures.

hal expose [OPTIONS]

Options

--list-stages#

List the stages for this macro.

-s, --stages <stages>#

Comma-separated list of stages to execute.

-c, --count <count>#

How many exposures to take. If exposing APOGEE and APOGEE exposure time is not explicitely defined, the last APOGEE exposure will finish as the BOSS readout begins.

--count-apogee <count_apogee>#

How many APOGEE exposures to take. Overrides –count.

--count-boss <count_boss>#

How many BOSS exposures to take. Overrides –count.

--apogee, -A, --no-apogee#

Expose APOGEE.

--boss, -B, --no-boss#

Expose BOSS.

--pairs, -P, --no-pairs#

Do dither pairs or single exposures. If –pairs, the exposure time for APOGEE refers to each dither and –counts refers to dither pairs.

--disable-dithering#

If set, the dither position will not change between exposures.

-b, --boss-exposure-time <boss_exposure_time>#

BOSS exposure time in seconds.

-a, --apogee-exposure-time <apogee_exposure_time>#

APOGEE exposure time in seconds. If not passed, matches the BOSS exposure.

-r, --reads <reads>#

Number of APOGEE reads. Incompatible with –apogee-exposure-time.

--initial-apogee-dither <initial_apogee_dither>#

Initial APOGEE dither position.

--with-fpi, --without-fpi#

Open the FPI shutter.

--stop#

Stops the execution of the command.

get_schema#

Returns the schema of the actor as a JSON schema.

hal get_schema [OPTIONS]

goto-field#

Execute the go-to-field macro.

hal goto-field [OPTIONS]

Options

--list-stages#

List the stages for this macro.

-s, --stages <stages>#

Comma-separated list of stages to execute.

--guider-time <guider_time>#

Exposure time for guiding/acquisition.

Default

15.0

--fixed-altaz#

Slews to a fixed alt/az position for the FVC loop.

--alt <alt>#

The fixed altitude angle to which to slew for the FVC loop. Requires –fixed-altaz to take effect.

--az <az>#

The fixed azimuth angle to which to slew for the FVC loop. Requires –fixed-altaz to take effect.

--rot <rot>#

The fixed rotator angle to which to slew for the FVC loop.

--stop#

Stops the execution of the command.

gotoAll60#

Send the telescope to (60, 60, 60).

hal gotoAll60 [OPTIONS]

Options

--stop#

Stops the execution of the command.

gotoInstrumentChange#

Send the telescope to (121, 90, 0).

hal gotoInstrumentChange [OPTIONS]

Options

--stop#

Stops the execution of the command.

gotoStow#

Send the telescope to (120, 30, 0).

hal gotoStow [OPTIONS]

Options

--stop#

Stops the execution of the command.

gotoStow60#

Send the telescope to (121, 60, 0).

hal gotoStow60 [OPTIONS]

Options

--stop#

Stops the execution of the command.

help#

Shows the help.

hal help [OPTIONS] [PARSER_COMMAND]

Arguments

PARSER_COMMAND#

Optional argument

keyword#

Prints human-readable information about a keyword.

hal keyword [OPTIONS] KEYWORD

Arguments

KEYWORD#

Required argument

ping#

Pings the actor.

hal ping [OPTIONS]

script#

Tools to list and run scripts.

hal script [OPTIONS] COMMAND [ARGS]...

cancel#

Cancels the execution of a script.

hal script cancel [OPTIONS] SCRIPT

Arguments

SCRIPT#

Required argument

get-steps#

Lists the steps in the script.

hal script get-steps [OPTIONS] SCRIPT

Arguments

SCRIPT#

Required argument

list#

Returns a list of available scripts.

hal script list [OPTIONS]

run#

Runs a script.

hal script run [OPTIONS] SCRIPT

Arguments

SCRIPT#

Required argument

running#

Returns a list of running scripts.

hal script running [OPTIONS]

status#

Outputs the status of the system.

hal status [OPTIONS]

Options

--full#

Outputs additional information.

version#

Reports the version.

hal version [OPTIONS]