Skip to content

Commit

Permalink
Doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
taldcroft committed Jan 8, 2024
1 parent 599376f commit 01224fd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
23 changes: 18 additions & 5 deletions kadi/commands/commands_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -483,16 +483,21 @@ def add_obs_cmds(
prev_obsid=None,
prev_simpos=None,
):
"""Add LOAD_EVENT OBS commands with info about observations.
"""Add 'type=LOAD_EVENT tlmsid=OBS' commands with info about observations.
This command includes the following:
This command params includes the following:
- manvr_start: date of maneuver start
- npnt_enab: auto-transition to NPNT enabled
- obs_start: as the command date
- obs_stop: date of subsequent AONMMODE or AONSMSAF command)
- obs_start: start date of NPNT corresponding to the command date
- obs_stop: stop date of NPNT (subsequent AONMMODE or AONSMSAF command)
- obsid: observation ID
- starcat_idx: index of starcat in reversed params dict
- prev_att: previous attitude (4-tuple of quaternion components)
- simpos: SIM position
- source: source of the observation (e.g. load name)
- starcat_date: date of starcat command (if available)
- starcat_idx: index of starcat in reversed params dict (if available)
- targ_att: target attitude (4-tuple of quaternion components)
Parameters
----------
Expand All @@ -504,6 +509,10 @@ def add_obs_cmds(
Dictionary of parameters from the command table, with keys reversed.
prev_att : tuple
Continuity attitude. If not supplied the first obs is dropped.
prev_obsid : int, optional
Previous obsid, default is -1.
prev_simpos : int, optional
Previous SIM position, default is -99616.
Returns
-------
Expand Down Expand Up @@ -778,6 +787,10 @@ def get_cmds_obs_final(
reversed dict of parameters for commands
schedule_stop_time
date of last command
prev_obsid : int, optional
Previous obsid, default is -1.
prev_simpos : int, optional
Previous SIM position, default is -99616.
Returns
-------
Expand Down
3 changes: 2 additions & 1 deletion kadi/commands/observations.py
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,8 @@ def get_observations(
'npnt_enab': True,
'obs_start': '2007:002:04:46:58.056',
'prev_att': (0.319214732, 0.535685207, 0.766039803, 0.155969017),
'starcat_idx': 144398,
'starcat_date': '2007:002:04:31:43.965',
'starcat_idx': 147908,
'source': 'DEC2506C'}
>>> obs_all = get_observations() # All observations in commands archive
Expand Down

0 comments on commit 01224fd

Please sign in to comment.