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

ptr.agm.api.agm_api, ptr.agm.AGM_CACHE

AGM REST API#

agm_api#

ptr.agm.api.agm_api(metakernel, ptr, endpoint, cache=True)[source]#

Call AGM through a REST API.

Parameters

  • metakernel (str) – Metakernel id.

  • ptr (str) – Pointing Timeline Request.

  • endpoint (str, optional) – Explicit AGM URL endpoint. You can also use the mission names listed in POINTING_TOOL_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#

class ptr.agm.results.AGMResults(results)[source]#

Bases: object

AGM results object.

Parameters

results (dict or pathlib.Path) – AGM formatted results.

property success: bool#

Results status success flag.

AGMInputParameters#

class ptr.agm.results.AGMInputParameters(res)[source]#

Bases: object

AGM input parameters.

AGMOutputResults#

class ptr.agm.results.AGMOutputResults(res)[source]#

Bases: object

AGM output results.

AGMResultsPTR#

class ptr.agm.results.AGMResultsPTR(ptr)[source]#

Bases: object

AGM PTR object.

AGMResultsQuaternions#

class ptr.agm.results.AGMResultsQuaternions(quaternions)[source]#

Bases: object

AGM results quaternions object.

AGMResultsCK#

class ptr.agm.results.AGMResultsCK(res)[source]#

Bases: ptr.agm.results.AGMResultsFile

AGM results CK object.

AGMResultsLog#

class ptr.agm.results.AGMResultsLog(log, session_id=None)[source]#

Bases: object

AGM results log object.

AGMResultsStatus#

class ptr.agm.results.AGMResultsStatus(success)[source]#

Bases: object

AGM results status object

property failure#

Failure flag.

property symbol#

Status symbol.

property color#

Status color.

AGM Cache#

ptr.agm.AGM_CACHE#

alias of <Cache> /tmp/esa-ptr | 2 entries: - d150d7aba57c403936aed01406282436 - d162fb62b4fbab5d350100e9ab9a50ce

Cache#

class ptr.agm.cache.Cache(cache)[source]#

Bases: object

AGM cache folder.

Parameters

cache (str or pathlib.Path) – Cache folder name.

property content#

List CK and NPY files in AGM cache

inspect(md5)[source]#

Inspect cached file.

remove(md5)[source]#

Remove the file from the cache.

purge()[source]#

Purge all AGM cache

md5_hash#

class ptr.agm.hash.md5_hash(metakernel: str, ptr: str, endpoint: str)[source]#

Bases:

MD5 inputs hashing method.

JUICE AGM simulator (CLI)#

ptr.cli.cli_juice_agm(argv=None)[source]#

CLI JUICE PTR validation with AGM.

By default, the metakernel used by AGM is JUICE CREMA 5.1 150lb_23_1. You can change this parameter with --mk flag.

AGM produced CK file are cached but you can download it explicitly if you want with a --ck flag.