satcat.cli package#

Submodules#

satcat.cli.create.ephemeris(file, file_format=<typer.models.ArgumentInfo object>, norad_id=None, comments=None, hbr_m=None, context=None, designation=None)#
satcat.cli.create.ephemeris_from_maneuver_plan(scenario_id=<typer.models.OptionInfo object>, tradespace_id=<typer.models.OptionInfo object>, plan_id=<typer.models.OptionInfo object>, designation=<typer.models.OptionInfo object>)#
satcat.cli.create.propagation(opm_file=<typer.models.OptionInfo object>, submit=<typer.models.OptionInfo object>, target_duration_s=<typer.models.OptionInfo object>, timestep_s=<typer.models.OptionInfo object>, purpose=<typer.models.OptionInfo object>, wait=<typer.models.OptionInfo object>)#
satcat.cli.create.screening(primary_ephemeris_file=<typer.models.OptionInfo object>, primary_ephemeris_format=<typer.models.OptionInfo object>, primary_norad_id=<typer.models.OptionInfo object>, primary_ephemeris_ids=None, secondary_ephemeris_ids=None, primary_opm_file=<typer.models.OptionInfo object>, catalog_id=None, threshold_radius_km=15.0, threshold_radius_active_km=None, threshold_radius_manned_km=None, threshold_radius_debris_km=None, default_secondary_hbr_m=5.0, propagation_start_time=None, propagation_duration=None, propagation_timestep=None, launch_window_start=None, launch_window_end=None, launch_window_cadence_s=None, type=ScreeningType.ON_ORBIT, auto_archive=False, include_primary_vs_primary=False, title=None, notes=None, submit=<typer.models.OptionInfo object>, use_best_catalog=True, use_ephemeris_repository=False, wait=<typer.models.OptionInfo object>)#
satcat.cli.download.ephemeris(resource_id, file_format=<typer.models.OptionInfo object>, output_file=<typer.models.OptionInfo object>)#

Download an Ephemeris by ID.

satcat.cli.download.plan(scenario_id, tradespace_id, plan_id, file_name, file_format=<typer.models.OptionInfo object>, output_file=<typer.models.OptionInfo object>)#

Download an Avoidance Maneuver Plan by ID.

satcat.cli.get.catalog(resource_id)#

Retrieve a Catalog by ID.

satcat.cli.get.conjunction_ccsds(screening_id, conjunction_id)#

Retrieve a single CCSDS formatted Conjunction by Screening ID.

satcat.cli.get.ephemeris(resource_id)#

Retrieve an Ephemeris by ID.

satcat.cli.get.propagation(resource_id)#

Retrieve a Propagation by ID.

satcat.cli.get.screening(resource_id)#

Retrieve a Screening by ID.

satcat.cli.list.catalogs(count=<typer.models.OptionInfo object>, latest=False)#
satcat.cli.list.conjunctions(screening_id=None, count=<typer.models.OptionInfo object>)#
satcat.cli.list.conjunctions_ccsds(resource_id, count=<typer.models.OptionInfo object>)#
satcat.cli.list.ephemerides(count=<typer.models.OptionInfo object>, catalog_id=None)#
satcat.cli.list.ephemeris_formats()#
satcat.cli.list.events(count=<typer.models.OptionInfo object>)#
satcat.cli.list.screening_primaries(screening_id, count=<typer.models.OptionInfo object>)#
satcat.cli.list.screening_secondaries(screening_id, count=<typer.models.OptionInfo object>)#
satcat.cli.list.screenings(count=<typer.models.OptionInfo object>, show_archived=False)#
satcat.cli.main.health_api()#
satcat.cli.main.main(output=<typer.models.OptionInfo object>, no_progress=<typer.models.OptionInfo object>)#
satcat.cli.main.version()#
satcat.cli.submit.propagation(resource_id, wait=<typer.models.OptionInfo object>)#

Submit a Propagation by ID.

satcat.cli.submit.screening(resource_id, wait=<typer.models.OptionInfo object>)#

Submit a Screening by ID.

class satcat.cli.utils.FetchingSpinner(message='Fetching data...')#

Bases: object

global_enable = True#
satcat.cli.utils.attribute_seek(base, path)#
satcat.cli.utils.cli_output(d, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, indent=2)#
satcat.cli.utils.cli_output_list(d, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, indent=2, fields=None)#
satcat.cli.utils.cli_output_model(model, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, indent=2, exclude_none=True, fields=None)#
satcat.cli.utils.display_class_keys_and_values(cls_or_module)#
satcat.cli.utils.resolve_field(base, operator)#
Return type:

str

satcat.cli.utils.resolve_field_name(field)#
Return type:

str

satcat.cli.utils.screening_await_cli(client, screening)#
satcat.cli.utils.validate_model_from_input(ctx, model, flag_prefix)#
satcat.cli.wait.propagation(resource_id, timeout=3600, poll_interval=5)#

Await completion of a Propagation.

satcat.cli.wait.screening(resource_id, timeout=3600, poll_interval=5)#

Await completion of a Screening.