adam_core.utils.helpers.orbits module¶

adam_core.utils.helpers.orbits.make_real_orbits(num_orbits: int | None = None) → Orbits[source]¶

Returns an ~adam_core.orbits.orbits.Orbits object with real orbits drawn from our list of sample objects.

Parameters:: num_orbits (optional, int) – The number of orbits to return, which must be less than or equal to the number of sample objects (27).
Returns:: orbits – Orbits object containing the sample orbits.
Return type:: ~adam_core.orbits.orbits.Orbits

adam_core.utils.helpers.orbits.make_simple_orbits(num_orbits: int = 10) → Orbits[source]¶

Returns an ~adam_core.orbits.orbits.Orbits object with simple orbits.

Parameters:: num_orbits (int, optional) – The number of orbits to return. Default is 10.
Returns:: orbits – Orbits object containing the sample orbits.
Return type:: ~adam_core.orbits.orbits.Orbits