query_ipp.py

#!/bin/env python
"""
query_ipp.py

Return details about Intra Proposal Priority that can be used for a RequestGroup.
"""
import requests

API_TOKEN = 'PlaceApiTokenHere'  # API token obtained from https://observe.lco.global/accounts/profile/
PROPOSAL_ID = 'PlaceProposalHere'  # Proposal IDs may be found here: https://observe.lco.global/proposals/

# The target of the observation, to be placed inside a configuration
target = {
    'name': 'm83',
    'type': 'ICRS',
    'ra': 204.253,
    'dec': -29.865,
    'epoch': 2000
}

# Additional constraints to be added to a configuration
constraints = {
    'max_airmass': 1.6,
    'min_lunar_distance': 30
}

# The configurations for this request. In this example we are taking 2 exposures with
# different filters and exposure times. The fields acquisition_config and guiding_config 
# are required fields in a configuration that are ultimately filled in with defaults 
# if the submitted values are empty.
configurations = [
    {
        'type': 'EXPOSE',
        'instrument_type': '1M0-SCICAM-SINISTRO',
        'target': target,
        'constraints': constraints,
        'acquisition_config': {},
        'guiding_config': {},
        'instrument_configs': [
            {
                'exposure_time': 30,
                'exposure_count': 1,
                'optical_elements': {
                    'filter': 'v'
                }
            }
        ]
    },
    {
        'type': 'EXPOSE',
        'instrument_type': '1M0-SCICAM-SINISTRO',
        'target': target,
        'constraints': constraints,
        'acquisition_config': {},
        'guiding_config': {},
        'instrument_configs': [
            {
                'exposure_time': 30,
                'exposure_count': 1,
                'optical_elements': {
                    'filter': 'b'
                }
            }
        ]
    }
]


# The time windows during which this request should be considered for observing. In this example we only provide one.
windows = [{
    'start': '2019-05-02 00:00:00',
    'end': '2019-05-30 00:00:00'
}]

# The telescope class that should be used for this observation
location = {
    'telescope_class': '1m0'
}

# The full requestgroup, with additional meta-data
requestgroup = {
    'name': 'Example Request 3',  # The title
    'proposal': PROPOSAL_ID,
    'ipp_value': 1.05,
    'operator': 'SINGLE',
    'observation_type': 'NORMAL',
    'requests': [{
        'configurations': configurations,
        'windows': windows,
        'location': location
    }]
}

# Now that we have a fully formed RequestGroup, we can query the API.
response = requests.post(
    'https://observe.lco.global/api/requestgroups/max_allowable_ipp/',
    headers={'Authorization': 'Token {}'.format(API_TOKEN)},
    json=requestgroup  # Make sure you use json!
)

# Make sure this api call was successful
try:
    response.raise_for_status()
except requests.exceptions.HTTPError as exc:
    print('Request failed: {}'.format(response.content))
    raise exc

ipp_dict = response.json()  # The API will return json with details about IPP available on this request.

# View the IPP details
print(ipp_dict)