API¶
This section provides comprehensive API documentation for the Ephemerista Python library.
See also
For user-friendly tutorials and examples, see the User Manual.
Module Overview¶
Scenarios – ephemerista.scenarios - Central scenario management and ensemble propagation
Assets – ephemerista.assets - Spacecraft and ground station models
Orbit Propagators – ephemerista.propagators - Orbital propagation engines (SGP4, numerical, semi-analytical)
Analysis – ephemerista.analysis - Analysis modules (visibility, coverage, link budget, navigation)
Comms – ephemerista.comms - Communication systems modeling
Constellations – ephemerista.constellation - Constellation design tools
Coordinates – ephemerista.coords - Coordinate systems and trajectory handling
Time – ephemerista.time - Time scales and epoch management
Frames – ephemerista.frames - Reference frame definitions
Plotting Tools – ephemerista.plot - Visualization and plotting utilities
Angles – ephemerista.angles - Angle utilities and conversions
Celestial Bodies – ephemerista.bodies - Celestial body definitions
Math – ephemerista.math - Mathematical utilities
- Analysis –
ephemerista.analysis- Available Analysis Modules
- Coverage –
ephemerista.analysis.coverageCoverageCoverageResultsCoverageResults.areasCoverageResults.avg_time_gapsCoverageResults.coverage_percentCoverageResults.discretized_coverage_percentCoverageResults.discretized_max_time_gapsCoverageResults.discretized_polygonsCoverageResults.max_time_gapsCoverageResults.min_time_gapsCoverageResults.num_discretized_polygonsCoverageResults.results_typeCoverageResults.from_coverage_results()CoverageResults.plot()CoverageResults.plot_mpl()CoverageResults.plot_plotly()CoverageResults.to_dataframe()CoverageResults.to_geodataframe()CoverageResults.polygonsCoverageResults.revisit_times
load_geojson_multipolygon()
- Link Budgets –
ephemerista.analysis.link_budgetEnvironmentalLossesEnvironmentalLosses.atmospheric_attenuationEnvironmentalLosses.cloud_attenuationEnvironmentalLosses.depolarization_lossEnvironmentalLosses.gaseous_attenuationEnvironmentalLosses.rain_attenuationEnvironmentalLosses.scintillation_attenuationEnvironmentalLosses.calculate()EnvironmentalLosses.no_losses()EnvironmentalLosses.sum()
InterferenceStatsLinkLinkBudgetLinkBudgetResultsLinkStatsLinkStats.bandwidthLinkStats.c_n0LinkStats.carrier_rx_powerLinkStats.data_rateLinkStats.eb_n0LinkStats.eirpLinkStats.frequencyLinkStats.fsplLinkStats.gtLinkStats.interference_statsLinkStats.lossesLinkStats.marginLinkStats.noise_powerLinkStats.rx_angleLinkStats.slant_rangeLinkStats.tx_angleLinkStats.calculate()LinkStats.add_interference()
- Visibility –
ephemerista.analysis.visibility
- Coverage –
- Available Analysis Modules
- Angles –
ephemerista.angles - Assets –
ephemerista.assetsAssetGroundLocationGroundLocation.altitudeGroundLocation.bodyGroundLocation.latitudeGroundLocation.longitudeGroundLocation.minimum_elevationGroundLocation.polygon_idsGroundLocation.from_lla()GroundLocation.get_minimum_elevation()GroundLocation.observables()GroundLocation.observables_batch()GroundLocation.propagate()GroundLocation.rotation_to_topocentric()
GroundStationObservablesSpacecraft
- Celestial Bodies –
ephemerista.bodies - Comms –
ephemerista.comms- Communication Components
- Antennas -
ephemerista.comms.antennas - Channels -
ephemerista.comms.channelsChannelChannel.channel_idChannel.data_rateChannel.forward_error_correctionChannel.link_typeChannel.marginChannel.modulationChannel.nameChannel.required_eb_n0Channel.roll_offChannel.bit_energy_to_noise_density()Channel.bit_energy_to_noise_interference_density()Channel.bits_per_symbol()Channel.bandwidth
- Receivers -
ephemerista.comms.receiverComplexReceiverComplexReceiver.antenna_noise_temperatureComplexReceiver.demodulator_lossComplexReceiver.implementation_lossComplexReceiver.lna_gainComplexReceiver.lna_noise_figureComplexReceiver.lossComplexReceiver.noise_figureComplexReceiver.receiver_typeComplexReceiver.gain_to_noise_temperature()ComplexReceiver.total_gain()ComplexReceiver.noise_temperatureComplexReceiver.system_noise_temperature
ReceiverSimpleReceiver
- Communication Systems -
ephemerista.comms.systemsCommunicationSystemCommunicationSystem.antennaCommunicationSystem.channelsCommunicationSystem.receiverCommunicationSystem.system_idCommunicationSystem.transmitterCommunicationSystem.carrier_power()CommunicationSystem.carrier_to_noise_density()CommunicationSystem.carrier_to_noise_interference_density()CommunicationSystem.noise_power()
- Transmitters -
ephemerista.comms.transmitter - Utilities -
ephemerista.comms.utils
- Antennas -
- Communication Components
- Constellations –
ephemerista.constellation- Constellation Tools
- Constellation Design –
ephemerista.constellation.designAbstractConstellationAbstractConstellation.inclinationAbstractConstellation.nameAbstractConstellation.originAbstractConstellation.periapsis_argumentAbstractConstellation.timeAbstractConstellation.define_satellites()AbstractConstellation.to_dataframe()AbstractConstellation.inclination_radiansAbstractConstellation.satellites
AbstractWalkerAbstractWalkerOrSocConstellationAbstractWalkerOrSocConstellation.eccentricityAbstractWalkerOrSocConstellation.nplanesAbstractWalkerOrSocConstellation.nsatsAbstractWalkerOrSocConstellation.semi_major_axisAbstractWalkerOrSocConstellation.define_planes()AbstractWalkerOrSocConstellation.to_dataframe()AbstractWalkerOrSocConstellation.planes
ConstellationFlowerStreetOfCoverageWalkerDeltaWalkerStarc_j()
- Constellation Planes –
ephemerista.constellation.plane
- Constellation Design –
- Constellation Tools
- Coordinates –
ephemerista.coords- Anomalies –
ephemerista.coords.anomalies - Events –
ephemerista.coords.events - Orbit Shapes –
ephemerista.coords.shapes - Trajectories –
ephemerista.coords.trajectoriesEventTrajectoryTrajectory.attitudeTrajectory.frameTrajectory.nameTrajectory.originTrajectory.start_timeTrajectory.statesTrajectory.trajectory_typeTrajectory.from_csv()Trajectory.find_events()Trajectory.interpolate()Trajectory.interpolate_batch()Trajectory.plot_3d()Trajectory.to_csv()Trajectory.to_frame()Trajectory.to_origin()Trajectory.cartesian_statesTrajectory.datetimesTrajectory.simulation_timeTrajectory.times
- Two-Body States –
ephemerista.coords.twobodyCartesianCartesian.frameCartesian.state_typeCartesian.vxCartesian.vyCartesian.vzCartesian.xCartesian.yCartesian.zCartesian.from_rv()Cartesian.isclose()Cartesian.rotation_lvlh()Cartesian.to_cartesian()Cartesian.to_dataframe()Cartesian.to_frame()Cartesian.to_keplerian()Cartesian.to_origin()Cartesian.positionCartesian.velocity
GEOInclinationKeplerianKeplerian.anomalyKeplerian.argKeplerian.incKeplerian.nodeKeplerian.shapeKeplerian.state_typeKeplerian.from_altitudes()Keplerian.from_elements()Keplerian.from_radii()Keplerian.is_physical()Keplerian.to_cartesian()Keplerian.to_dataframe()Keplerian.to_keplerian()Keplerian.apoapsis_radiusKeplerian.ascending_nodeKeplerian.eccentricityKeplerian.inclinationKeplerian.mean_anomalyKeplerian.orbital_periodKeplerian.periapsis_argumentKeplerian.periapsis_radiusKeplerian.semi_major_axisKeplerian.true_anomaly
LEOMEOSSOTwoBody
- Anomalies –
- Frames –
ephemerista.frames - Math –
ephemerista.math - Plotting Tools –
ephemerista.plot - Orbit Propagators –
ephemerista.propagators- Available Propagators
- Orekit-based Propagators and Utilities –
ephemerista.propagators.orekit - SGP4 Propagator -
ephemerista.propagators.sgp4 - Precomputed Trajectory Interpolator -
ephemerista.propagators.oem
- Orekit-based Propagators and Utilities –
- Available Propagators
- Scenarios –
ephemerista.scenariosEnsembleRectangleScenarioScenario.areas_of_interestScenario.assetsScenario.auto_discretizeScenario.channelsScenario.constellationsScenario.discretization_methodScenario.discretization_resolutionScenario.end_timeScenario.frameScenario.nameScenario.originScenario.points_of_interestScenario.scenario_idScenario.start_timeScenario.time_stepScenario.load_from_file()Scenario.channel_by_id()Scenario.get_discretized_to_original_mapping()Scenario.get_original_to_discretized_mapping()Scenario.propagate()Scenario.all_assetsScenario.discretized_areasScenario.ground_locationsScenario.times
polygonize_aoi()polygonize_aoi_rectangles()
- Time –
ephemerista.timeISOTimestampJulianDateTimestampSecondsTimestampTimeTime.scaleTime.timestampTime.from_components()Time.from_day_of_year()Time.from_iso()Time.from_j2000()Time.from_julian_date()Time.from_two_part_julian_date()Time.from_utc()Time.isclose()Time.to_scale()Time.to_utc()Time.trange()Time.trange_fast()Time.datetimeTime.dayTime.day_of_yearTime.hourTime.j2000Time.julian_dateTime.minuteTime.monthTime.secondTime.secondsTime.two_part_julian_dateTime.year
UTCTimestamp