spherapy 0.2.1__py3-none-any.whl → 0.3.1__py3-none-any.whl

spherapy/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.1'
-__version_tuple__ = version_tuple = (0, 2, 1)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)
 
 __commit_id__ = commit_id = None

spherapy/orbit.py

@@ -626,7 +626,8 @@ class Orbit:
 											inc:float=0,
 											raan:float=0,
 											argp:float=0,
-											mean_nu:float=0,
+											true_nu:float=0,
+											epoch:dt.datetime|None=None,
 											name:str='Analytical',
 											astrobodies:bool=True,
 											unsafe:bool=False) -> 'Orbit':
@@ -651,8 +652,11 @@ class Orbit:
 			argp: [Optional] argument of the perigee in degrees
 					Default is 0, which	represents an orbit with its semimajor axis in
 					the plane of the Earth's equator
-			mean_nu: [Optional] mean anomaly in degrees
-					Default is 0, which represents an orbit that is beginning at periapsis
+			true_nu: [Optional] true anomaly at epoch in degrees
+					Default is 0, which represents an orbit that is beginning
+					at periapsis on the epoch
+			epoch: [Optional] epoch for orbit
+					Default is the first timestep of the timespan
 			name: [Optional] string giving the name of the orbit
 					Default is 'Analytical'
 			astrobodies: [Optional] Flag to calculate Sun and Moon positions at timestamps
@@ -705,13 +709,25 @@ class Orbit:
 			raise exceptions.OutOfRangeError(f"Argument of periapsis, {raan}, is out of "
 										f"range, should be 0 < argp < 360")
 
-		if mean_nu > 360 or mean_nu < 0: 		#noqa: PLR2004
-			logger.error("Mean anomaly, %s, is out of range, should be 0 < mean_nu < 360", mean_nu)
-			raise exceptions.OutOfRangeError(f"Mean anomaly, {mean_nu}, is out of range, "
-										f"should be 0 < mean_nu < 360")
+		if true_nu > 360 or true_nu < 0: 		#noqa: PLR2004
+			logger.error("True anomaly, %s, is out of range, should be 0 < true_nu < 360", true_nu)
+			raise exceptions.OutOfRangeError(f"True anomaly, {true_nu}, is out of range, "
+										f"should be 0 < true_nu < 360")
+
+		if epoch is None:
+			epoch = timespan[0]
+		if isinstance(epoch, dt.datetime):
+			astropy_epoch = astropyTime(epoch, scale='utc')
+		else:
+			logger.error("epoch, %s must be of type dt.datetime|astropyTime but"
+											" is of type %s", epoch, type(epoch))
+			raise TypeError(f"epoch, {epoch} must be of type "
+						f"dt.datetime|astropyTime but is of type {type(epoch)}")
 
 		attr_dct = _createEmptyOrbitAttrDict()
 
+
+
 		logger.info("Creating analytical orbit")
 		orb = hapsiraOrbit.from_classical(central_body,
 											a * astropy_units.one * astropy_units.km,
@@ -719,7 +735,9 @@ class Orbit:
 											inc * astropy_units.one * astropy_units.deg,
 											raan * astropy_units.one * astropy_units.deg,
 											argp * astropy_units.one * astropy_units.deg,
-											mean_nu * astropy_units.one * astropy_units.deg)
+											true_nu * astropy_units.one * astropy_units.deg,
+											astropy_epoch
+											)
 
 
 		logger.info("Creating ephemeris for orbit, using timespan")

spherapy/timespan.py

@@ -6,7 +6,7 @@ This module provides:
 import datetime as dt
 import logging
 
-from typing import cast
+from typing import cast, overload
 from typing_extensions import Self
 
 from astropy.time import Time as astropyTime
@@ -112,6 +112,16 @@ class TimeSpan:
 		"""Returns the internal _timearr when the TimeSpan is called."""
 		return self._timearr
 
+	@overload
+	def __getitem__(self, idx: None) -> np.ndarray[tuple[int], np.dtype[np.datetime64]]: ...
+
+	@overload
+	def __getitem__(self, idx: int | np.integer) -> dt.datetime: ...
+
+	@overload
+	def __getitem__(self, idx: slice | list[int] | tuple[int, ...] | np.ndarray) \
+						-> np.ndarray[tuple[int], np.dtype[np.datetime64]]: ...
+
 	def __getitem__(self, idx:None|int|np.integer|tuple|list|np.ndarray|slice=None) \
 						-> None|dt.datetime|np.ndarray[tuple[int], np.dtype[np.datetime64]]: 	# noqa: PLR0911
 		"""Returns an index or slice of the TimeSpan as an array of datetime objects."""
@@ -124,7 +134,7 @@ class TimeSpan:
 				return self._timearr[idx[0]:idx[1]]
 			return self._timearr[idx[0]:idx[1]:idx[2]]
 		if isinstance(idx, list):
-			return self._timearr[[idx]]
+			return self._timearr[idx]
 		if isinstance(idx, np.ndarray):
 			return self._timearr[idx]
 		if isinstance(idx,slice):

spherapy/util/epoch_u.py

@@ -147,3 +147,66 @@ def getStoredEpochs(tle_path:pathlib.Path) -> None|tuple[dt.datetime, dt.datetim
 	last_epoch_dt = epoch2datetime(last_tle_line_1['fields'][3])
 
 	return (first_epoch_dt, last_epoch_dt)
+
+def getAllStoredEpochs(tle_path:pathlib.Path) -> None|list[dt.datetime]:
+	"""Return the all TLE epochs for tle_path.
+
+	Args:
+		tle_path: tle file
+
+	Returns:
+		list of datetime object equivalent to the TLE epoch for each TLE
+		None if no spacetrack tle stored for sat_id
+	"""
+	if not tle_path.exists():
+		return None
+
+	with tle_path.open('r') as fp:
+		lines = fp.readlines()
+
+	tle_epochs_dt = []
+	for ii in range(1,len(lines),3):
+		tle_line = elements_u.split3LELineIntoFields(lines[ii])
+		tle_epochs_dt.append(epoch2datetime(tle_line['fields'][3]))
+
+
+	return tle_epochs_dt
+
+def getStoredTLEByIdx(tle_path:pathlib.Path,
+						idx_list:int|list[int],
+						string_only:bool=True) \
+							-> list[dict[int, elements_u.ElementsLineDict]]|list[str]|None:
+	"""Return the TLE at the Idx within tle_path specifed by idx_list.
+
+	Args:
+		tle_path: tle file
+		idx_list: list of TLE indices within tle_path
+		string_only: if true, return only the raw TLE string,
+					if false returns a dict of each field within each line
+
+	Returns:
+		list of tle_data
+	"""
+	if not tle_path.exists():
+		return None
+
+	if isinstance(idx_list, int):
+		idx_list = [idx_list]
+
+	with tle_path.open('r') as fp:
+		lines = fp.readlines()
+
+	tles = []
+	for idx in idx_list:
+		tle_line_0 = elements_u.split3LELineIntoFields(lines[idx*3+0])
+		tle_line_1 = elements_u.split3LELineIntoFields(lines[idx*3+1])
+		tle_line_2 = elements_u.split3LELineIntoFields(lines[idx*3+2])
+
+		if string_only:
+			tle_data = f"{tle_line_0['line_str']}{tle_line_1['line_str']}{tle_line_2['line_str']}"
+		else:
+			tle_data = {0:tle_line_0, 1:tle_line_1, 2:tle_line_2} 	#type:ignore
+
+		tles.append(tle_data)
+
+	return tles

{spherapy-0.2.1.dist-info → spherapy-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spherapy
-Version: 0.2.1
+Version: 0.3.1
 Summary: An orbital propagator wrapper and TLE fetcher
 Author-email: Robert Mearns <rz.mearns@gmail.com>
 Maintainer-email: Robert Mearns <rz.mearns@gmail.com>
@@ -21,6 +21,7 @@ Requires-Dist: spacetrack==1.2.0
 Requires-Dist: keyring>=25.0.0
 Requires-Dist: platformdirs==4.3.8
 Requires-Dist: importlib_resources>=6.5.2
+Requires-Dist: coverage>=7.6.1
 Provides-Extra: dev
 Requires-Dist: line-profiler==4.2.0; extra == "dev"
 Requires-Dist: pytest==8.4.1; extra == "dev"
@@ -87,7 +88,7 @@ o = spherapy.orbit.Orbit.fromAnalyticalOrbitalParam(timespan, body='Earth',
 					 inc=0,
 					 raan=0,
 					 argp=0,
-					 mean_nu=0,
+					 true_nu=0,
 					 name='My Analytical Orbit',
 					 astrobodies=True)
 ```  
@@ -115,7 +116,7 @@ o = spherapy.orbit.Orbit.fromAnalyticalOrbitalParam(timespan, body='Earth',
 					 inc=0,
 					 raan=0,
 					 argp=0,
-					 mean_nu=0,
+					 true_nu=0,
 					 name='My Analytical Orbit',
 					 astrobodies=True)
 ```

{spherapy-0.2.1.dist-info → spherapy-0.3.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
 spherapy/__init__.py,sha256=v1n13-2Uuy8GEWkB_B5mu2tSkAOVEPVP2eF0GixSPtI,2865
 spherapy/__main__.py,sha256=YOcE__6OgX-e7lJ6UpeGS8Iw5igG0jEraTq8KOqGuDA,374
-spherapy/_version.py,sha256=vYqoJTG51NOUmYyL0xt8asRK8vUT4lGAdal_EZ59mvw,704
-spherapy/orbit.py,sha256=MyRa1U5cEdzP1yhFLbp25T1kHqTpZVnj75Siwfe6vbo,32607
-spherapy/timespan.py,sha256=xc5JEYtDcG4zZdsbdW9lcIX_PXzXzNJ-xGD_bCWJFDs,14438
+spherapy/_version.py,sha256=gGLpQUQx-ty9SEy9PYw9OgJWWzJLBnCpfJOfzL7SjlI,704
+spherapy/orbit.py,sha256=AIJVG5XUeHmIIrwlSZMWB-HdaOokQyaiXUezyFO40sU,33180
+spherapy/timespan.py,sha256=LwBJ4InQrrsFcIVF5mT0Tp6AlTLk9rzhO6lL66ypTRU,14780
 spherapy/updater.py,sha256=pkZg3ZlFbCa2iDJ2CP9al8t0BoDGRnppte54Vqkw1M4,3215
 spherapy/data/TLEs/25544.tle,sha256=D-kndlhtWawbxR8tCU-7QZB1VZxROzutUBgc1ZwO4C0,7873403
 spherapy/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -10,13 +10,13 @@ spherapy/util/celestrak.py,sha256=9uFtau90NOpXGc-Vkww4uKiFcrEnriXQjb-hfO50kaE,22
 spherapy/util/constants.py,sha256=sm53FCsupvkUC3eajfn-haFIqnonJHykOL3klWTikaA,1810
 spherapy/util/credentials.py,sha256=NS5eIdjEOumzZ8BqzRZ9mWp8BhRdfGWbY6qQkMjzS90,4057
 spherapy/util/elements_u.py,sha256=ycHTu0-p6ZNI8WHpNPanGf0a-WOLY7PaWphyG_AEJ28,2058
-spherapy/util/epoch_u.py,sha256=IgSBumtS28JajLLkMLq-ST-qypoicqMdybXoAPTsjmo,3880
+spherapy/util/epoch_u.py,sha256=8lNTwP9bng1V_SABqDK4bEKLUUewKT_TrpjwE1sKh3c,5539
 spherapy/util/exceptions.py,sha256=rDqYIhNdKnYBkbkxdhndSYI4mq4ENKtW01jEfZ7Yykk,215
 spherapy/util/orbital_u.py,sha256=GKTNpiMTB7NAX-0TtD3lcHz5rFY2P_91odUnEBX-CJA,1760
 spherapy/util/spacetrack.py,sha256=Kbh8IVgFN1UMegWxI1thxHx2gY5fEJ6ofT692-JmKA8,8165
-spherapy-0.2.1.dist-info/licenses/LICENSE.md,sha256=9a5OXeKpk6GnCRhlQAPa5JQjl3PaFqseA1p2_DhXEbA,1055
-spherapy-0.2.1.dist-info/METADATA,sha256=UiluR8rndZ4AuF8R_J3c7aJRyZC4lr9HgTgx_geORfQ,7756
-spherapy-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-spherapy-0.2.1.dist-info/entry_points.txt,sha256=WpE3jlS6iiug9ZqUrAHQuLEhbDTpbnAtBz8b0yXJJOU,150
-spherapy-0.2.1.dist-info/top_level.txt,sha256=X4rv7pGR9bAfVWOokUyHeDb6Z0jfIQCN6zDfh5f2NK4,9
-spherapy-0.2.1.dist-info/RECORD,,
+spherapy-0.3.1.dist-info/licenses/LICENSE.md,sha256=9a5OXeKpk6GnCRhlQAPa5JQjl3PaFqseA1p2_DhXEbA,1055
+spherapy-0.3.1.dist-info/METADATA,sha256=RTT0299ARVjTKiMmWXtWVyB5H_DtgrdUU5fuYdljPVs,7787
+spherapy-0.3.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+spherapy-0.3.1.dist-info/entry_points.txt,sha256=WpE3jlS6iiug9ZqUrAHQuLEhbDTpbnAtBz8b0yXJJOU,150
+spherapy-0.3.1.dist-info/top_level.txt,sha256=X4rv7pGR9bAfVWOokUyHeDb6Z0jfIQCN6zDfh5f2NK4,9
+spherapy-0.3.1.dist-info/RECORD,,

{spherapy-0.2.1.dist-info → spherapy-0.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any