AGM API
Contents
AGM API#
agm_simulation
#
- ptr.agm_simulation(metakernel, ptr, endpoint, cache=True) ptr.agm.results.AGMResults [source]#
ESA Attitude Generator Module simulation.
- Parameters
metakernel (str) – Metakernel id.
ptr (str or pathlib.Path) – Pointing Timeline Request content or file.
endpoint (str, optional) – AGM endpoint simulator. It can be an explicit API URL endpoint or an implicit API keyword, eg.
'JUICE_API'
.cache (bool, optional) – Use cache the result of the simulation.
Note
Currently, AGM API requests is supported. Usage of locally installed AGM instance is envision in the future.
See also
AGM REST API#
AGM_URL_ENDPOINTS
#
- ptr.agm.api.AGM_URL_ENDPOINTS#
alias of {‘JUICE_API’: ‘https://juicept.esac.esa.int/agm’}
agm_api
#
- ptr.agm.api.agm_api(metakernel, ptr, url, cache=True)[source]#
Call AGM through a REST API.
- Parameters
metakernel (str) – Metakernel id.
ptr (str) – Pointing Timeline Request.
url (str, optional) – Explicit AGM URL endpoint. You can also use the mission name listed in
AGM_URL_ENDPOINTS
like'JUICE_API'
.cache (bool, optional) – Use cache the response if present locally.
- Raises
ValueError – If the URL endpoint is unknown.
AGM Results#
AGMResults
#
AGMInputParameters
#
AGMOutputResults
#
AGMResultsPTR
#
AGMResultsQuaternions
#
AGMResultsCK
#
AGMResultsLog
#
AGMResultsStatus
#
AGM CachAGM_CACHEe#
- ptr.agm.AGM_CACHE#
alias of <Cache> /tmp/esa-ptr | 1 entry: - bc499e6067a80c4b4edbcb9d48110c5e