b.bal(mgrs=("pf", "ifrack", "acs"), options = opt)

g.bal(mgrs=("pf", "ifrack", "acs"), options = opt)

1. Introduction

1. Introduction

Recommended practices for visiting observers:

Recommended practices for visiting observers:

• Issue commands within a Scheduling Block/turtle observing script, or

• Issue commands within a Scheduling Block (turtle observing script), or

Advanced methods also available for staff scientists and programmers include:

Advanced methods also available for staff scientists and programmers include:

• or the config_tool if is it loaded separately.

• or the config_tool if it is being used as a standalone application.

2. Balancing from the Python Command Line

2. Balancing from the Python Command Line

From the command line, the Balance class serves as the interface to the API. Its use can most easily be described by an example.

From the command line, the Balance class serves as the interface to the API. Its use can most easily be described by an example.

3. Balancing from the Config Tool

3. Balancing from the Config Tool

The bal() method accepts the following optional parameters:

The config tool provides its own interface to the Balance API. The interface is through one method called bal(). The bal() method accepts the following optional parameters:

To perform a balance from the config tool interface type :

To perform a balance from the config_tool interface type :

This results in the IFRack to be balanced.

This results in the IFRack being balanced.

Results in balancing the Prime Focus Receiver, followed by the IFRack, followed by the Spectrometer. The default parameters are used in balancing all the devices.

Results in balancing the Prime Focus Receiver, followed by the IFRack, followed by the Spectrometer. The default parameters are used in balancing all the devices.

Alternately to specify balancing options

Alternately, to specify balancing options directly,

The Prime Focus receiver will be balanced with the sample_time of 5 and the cal diodes "on" (if they are currently "on")

The Prime Focus receiver will be balanced with the sample_time of 5 and the cal diodes "on" (if they are currently "on"). The IFRack will be balanced (Note that there are no balancing options for the IFRack). The Spectrometer will be balanced with the resulting duty cycles displayed for ports 9 and 13.

The IFRack will be balanced. Note that there are no balancing options for the IFRack

The Spectrometer will be balanced with the resulting duty cycles displayed for ports 9 and13

4. Balancing from the Astromomers Integrated Desktop (Astrid)

4. Balancing from the Astromomers Integrated Desktop (Astrid)

Balancing During an Observation

Balancing is often done prior to a scan, which can be easily commanded into a Scheduling Block. Full instructions can be found here, under instructions for Balance.

Balancing While a Scan is Running

Astrid contains a python shell, called the "Command Console" that comes with both the Balance and Configuration APIs pre-loaded. If an astronomer wishes to balance in-process, that is, while a scan is underway, he or she should follow either the directions for using the config_tool or the Balance API found above in Sections 2 and 3. The recommended syntax is:

For balancing one device:

Balance(["ifrack"])

         OR

Balance(("ifrack",))

Be sure to remember the trailing comma if a tuple is chosen for input to Balance.

For balancing multiple devices:

Balance(["ifrack","pf","sp","acs"])

         OR

Balance(("ifrack","pf","sp","acs"))

5. Core Team

5. Core Team

There are 3 ways to use the Balance API: through the Python Command Line, the Astrid "Command Console", or the config_tool if is it loaded separately.

There are many ways to access the Balance API:

1.1 Supported Devices

Recommended practices for visiting observers:

• Issue commands within a Scheduling Block/turtle observing script, or
• Use the Astrid "Command Console" to interactively balance when the science cannot be accomplished by balancing within the Scheduling Block.

Advanced methods also available for staff scientists and programmers include:

• through the Python Command Line,
• or the config_tool if is it loaded separately.

Regardless of what technique is selected, five devices are supported. These are:

• Spectrometer ("acs"),
• IF Rack ("ifrack"),
• Prime Focus Receivers ("pf"),
• BCPM ("bcpm") and
• Spectral Processor ("sp").

In order for a balance of the Prime Focus receiver to be accomplished, it MUST BE SELECTED in the Scan Coordinator's "receiver" parameter before the balance command is performed.

There are 3 ways to use the Balance API: through the python command line, the config tool and the Observing API. The config tool and the Observing API both have a user interface to the Balance API.

There are 3 ways to use the Balance API: through the Python Command Line, the Astrid "Command Console", or the config_tool if is it loaded separately.

The supported devices are the Spectrometer ("acs"), IF Rack ("ifrack"), Prime Focus Receivers ("pf"). BCPM (bcpm) and the SpectralProcessor ("spp"). In order for a balance of the Prime Focus receiver to be accomplished, it must be selected in the ScanCoordinators' "receiver" parameter before the balance command is performed.

The supported devices are the Spectrometer ("acs"), IF Rack ("ifrack"), Prime Focus Receivers ("pf"), BCPM ("bcpm") and the Spectral Processor ("sp"). In order for a balance of the Prime Focus receiver to be accomplished, it MUST BE SELECTED in the Scan Coordinator's "receiver" parameter before the balance command is performed.

2. Balancing from the Python Command Line

2. Balancing from the python command line

* From python import the Balance module:

• Within Python, import the Balance module:

• Create a Balance object with a list of the devices to be balanced. Supported devices are "acs", "ifrack", "pf", "bcpm" and "sp".

* Create a Balance object with a list of the devices to be balanced. Supported devices are "acs", "ifrack", "pf", "bcpm" and "spp".

          b = Balance(["pf", "ifrack"])

b = Balance(("pf", "ifrack"))

If no parameters are specifed, the ifrack is the default device.

If no parameters are specifed, the ifrack will be treated as the default device.

The supported devices are the Spectrometer ("acs"), IF Rack ("ifrack"), Prime Focus Receivers ("pf") and the SpectralProcessor ("sp").

The supported devices are the Spectrometer ("acs"), IF Rack ("ifrack"), Prime Focus Receivers ("pf"). BCPM (bcpm) and the SpectralProcessor ("spp").

* Create a Balance object with a list of the devices to be balanced. Supported devices are "acs", "ifrack", "pf" and "sp".

* Create a Balance object with a list of the devices to be balanced. Supported devices are "acs", "ifrack", "pf", "bcpm" and "spp".

target_level = -11 Applicable when balancing the SpectralProcessor? (sp) :

target_level = -11 Applicable when balancing the SpectralProcessor? (spp) :

• mgrs = a list of devices to be balanced ( Supported devices are "acs", "ifrack", "pf" and "sp" )

• mgrs = a list of devices to be balanced ( Supported devices are "acs", "ifrack", "pf", "bcpm" and "spp" )

4. Core Team

4. Balancing from the Astromomers Integrated Desktop (Astrid)

5. Core Team

from gbt.ygor.Balance import *

from Balance import *

SpectralProcess? (sp) : target_level = -11 Spectrometer (acs) : port = (1..41) PrimeFocusReceivers?(pf) : sample_time = 2, cal = 'off' IFRack(ifrack) : NA

target_level = -11 Applicable when balancing the SpectralProcessor? (sp) : port = (1..41) Applicable when balancing the Spectrometer (acs) sample_time = 2 Applicable when balancing thePrimeFocusReceivers(pf) cal = 'off' Applicable when balancing the PrimeFocusReceivers?(pf)

The config tool provides its own interface to the Balance API.

The interface is through one method called bal().

The config tool provides its own interface to the Balance API. The interface is through one method called bal().

mgrs = a list of devices to be balanced ( Supported devices are "acs", "ifrack", "pf" and "sp" ) options = a python dictionary that contains balancing options sim = a simulation flag . Setting sim = 1 will cause the bal method to not actally balance the devices

• mgrs = a list of devices to be balanced ( Supported devices are "acs", "ifrack", "pf" and "sp" )

• options = a python dictionary that contains balancing options

• sim = a simulation flag . Setting sim = 1 will cause the bal method to not actally balance the devices

mgrs : ("ifrack",) options : { "target_level" : -11,

• mgrs : ("ifrack",)

• options : { "target_level" : -11,

sim : 0

To perform a balance from the config tool interface type :

• sim : 0

To perform a balance from the config tool interface type :

The command:

alternately to specify balancing options

Alternately to specify balancing options

The Spectrometer will be balanced with the with the resulting duty cycles displayed for ports 9 and13

The Spectrometer will be balanced with the resulting duty cycles displayed for ports 9 and13

The supported devices are the Spectrometer ("ACS"), IF Rack ("IFrack"), Prime Focus Receivers ("Pf") and the SpectralProcessor ("Spp").

The supported devices are the Spectrometer ("acs"), IF Rack ("ifrack"), Prime Focus Receivers ("pf") and the SpectralProcessor ("sp").

* Create a Balance object with a list of the devices to be balanced. Supported devices are "ACS", "IFrack", "Pf" and "Spp".

* Create a Balance object with a list of the devices to be balanced. Supported devices are "acs", "ifrack", "pf" and "sp".

b = Balance(("Pf", "IFrack"))

b = Balance(("pf", "ifrack"))

If no parameters are specifed, the IFrack is the default device.

If no parameters are specifed, the ifrack is the default device.

SpectralProcess? (Spp) : target_level = -11 Spectrometer (ACS) : port = (1..41) PrimeFocusReceivers?(Pf) : sample_time = 2, cal = 'off' IFRack(IFRack) : NA

SpectralProcess? (sp) : target_level = -11 Spectrometer (acs) : port = (1..41) PrimeFocusReceivers?(pf) : sample_time = 2, cal = 'off' IFRack(ifrack) : NA

mgrs = a list of devices to be balanced ( Supported devices are "ACS", "IFRack", "Pf" and "Spp" )

mgrs = a list of devices to be balanced ( Supported devices are "acs", "ifrack", "pf" and "sp" )

mgrs : ("IFRack",)

mgrs : ("ifrack",)

g.bal(mgrs=("Pf", "IFRack", "ACS"))

g.bal(mgrs=("pf", "ifrack", "acs"))

b.bal(mgrs=("Pf", "IFRack", "ACS"), options = opt)

b.bal(mgrs=("pf", "ifrack", "acs"), options = opt)

The supported devices are the Spectrometer ("ACS"), IF Rack ("IFRack"), Prime Focus Receivers ("Pf") and the SpectralProcessor ("Spp").

The supported devices are the Spectrometer ("ACS"), IF Rack ("IFrack"), Prime Focus Receivers ("Pf") and the SpectralProcessor ("Spp").

* Create a Balance object with a list of the devices to be balanced. Supported devices are "ACS", "IFRack", "Pf" and "Spp".

* Create a Balance object with a list of the devices to be balanced. Supported devices are "ACS", "IFrack", "Pf" and "Spp".

b = Balance(("Pf", "IFRack"))

b = Balance(("Pf", "IFrack"))

If no parameters are specifed, the IFRack is the default device.

If no parameters are specifed, the IFrack is the default device.

The balance method performs a balance on each of the devices specified in the constructor. In this example, balancing is performed with the default balancing options for each device. The devices are balanced in the order specified in the list. In the above example, the Prime Focus receiver is balanced first, followed by the IFRack.

The balance method performs a balance on each of the devices specified in the constructor. In this example, balancing is performed with the default balancing options for each device. The devices are balanced in the order specified in the list. In the above example, the Prime Focus receiver is balanced first, followed by the IFrack.

%META:TOPICINFO{author="MelindaMello" date="1102022220" format="1.0" version="1.1"}%

GBT Balance Usage

• GBT Balance Usage
• 1. Introduction
  • 1.1 Supported Devices
• 2. Balancing from the python command line
• 3. Balancing from the Config Tool
• 4. Core Team

1. Introduction

1.1 Supported Devices

2. Balancing from the python command line

* From python import the Balance module:

from gbt.ygor.Balance import *

* Create a Balance object with a list of the devices to be balanced. Supported devices are "ACS", "IFRack", "Pf" and "Spp".

b = Balance(("Pf", "IFRack"))

If no parameters are specifed, the IFRack is the default device.

*To perform the balance, the balance method is called.

b.balance()

The balance method performs a balance on each of the devices specified in the constructor. In this example, balancing is performed with the default balancing options for each device. The devices are balanced in the order specified in the list. In the above example, the Prime Focus receiver is balanced first, followed by the IFRack.

An optional parameter to the balance method can be provided. This parameter must be a dictionary that contains 1 or more of the following balancing options. Items which are not in the dictionary are assigned their default values. Non applicable options are ignored.

The default values are:

              SpectralProcess (Spp)    : target_level =  -11
              Spectrometer (ACS)       : port = (1..41)
              PrimeFocusReceivers(Pf)  : sample_time = 2,    cal = 'off'
              IFRack(IFRack)           :  NA

Supported dictionary keys/value type are:

        target_level / float
        sample_time  / int
        cal / string containing "on" or "off" -- other values will be treated as if "on" was specified
        port/ tuple containing integers from 1 to 41

An example of a dictionary containing valid options and its use in a balance method call is:

         opt = { "target_level": 4, 
                 "sample_time" : 5,
                 "cal"         : "on",
                 "port"        : (9,13)
                }
         b.balance(opt)

3. Balancing from the Config Tool

The interface is through one method called bal().

The bal() method accepts the following optional parameters: mgrs = a list of devices to be balanced ( Supported devices are "ACS", "IFRack", "Pf" and "Spp" ) options = a python dictionary that contains balancing options sim = a simulation flag . Setting sim = 1 will cause the bal method to not actally balance the devices

All the parameters are optional. The default values for these parameters are: mgrs : ("IFRack",) options : { "target_level" : -11, "sample_time" : 2, "cal" : "off", "port" : (1..41) } sim : 0

To perform a balance from the config tool interface type :

g = gbtsetup()

g.bal()

This results in the IFRack to be balanced.

g.bal(mgrs=("Pf", "IFRack", "ACS"))

Results in balancing the Prime Focus Receiver, followed by the IFRack, followed by the Spectrometer. The default parameters are used in balancing all the devices.

alternately to specify balancing options

         opt = { "sample_time" : 5,
                 "cal"         : "on",
                 "port"        : (9,13)
                }
   
      b.bal(mgrs=("Pf", "IFRack", "ACS"), options = opt)

The Prime Focus receiver will be balanced with the sample_time of 5 and the cal diodes "on" (if they are currently "on")

The IFRack will be balanced. Note that there are no balancing options for the IFRack

The Spectrometer will be balanced with the with the resulting duty cycles displayed for ports 9 and13

4. Core Team

-- MelindaMello - 02 Dec 2004