spherapy 0.2.0__py3-none-any.whl

spherapy-0.2.0.dist-info/METADATA

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: spherapy
+Version: 0.2.0
+Summary: An orbital propagator wrapper and TLE fetcher
+Author-email: Robert Mearns <rz.mearns@gmail.com>
+Maintainer-email: Robert Mearns <rz.mearns@gmail.com>
+Project-URL: Documentation, https://rzmearns.github.io/spherapy/
+Project-URL: Repository, https://github.com/rzmearns/spherapy
+Project-URL: Issues, https://github.com/rzmearns/spherapy/issues
+Keywords: satellite,sgp,space,orbit
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: astropy==5.3.4
+Requires-Dist: scipy>=1.8.0
+Requires-Dist: skyfield==1.46
+Requires-Dist: numpy>=1.25.2
+Requires-Dist: progressbar2==4.4.1
+Requires-Dist: hapsira==0.18.0
+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
+Provides-Extra: dev
+Requires-Dist: line-profiler==4.2.0; extra == "dev"
+Requires-Dist: pytest==8.4.1; extra == "dev"
+Requires-Dist: pytest-check==2.5.3; extra == "dev"
+Requires-Dist: mypy==1.17.0; extra == "dev"
+Requires-Dist: ruff==0.12.4; extra == "dev"
+Requires-Dist: pre-commit==4.2.0; extra == "dev"
+Requires-Dist: types-requests>=2.32.4; extra == "dev"
+Requires-Dist: types-python-dateutil>=2.9.0; extra == "dev"
+Dynamic: license-file
+
+## About
+Spherapy is a convenience wrapper around the fantastic libraries [skyfield](https://pypi.org/project/skyfield/), [spacetrack](https://pypi.org/project/spacetrack/), and [hapsira](https://pypi.org/project/hapsira/) (a maintained poliastro fork).
+It provides a consistent and straightforward method to create/propagate orbits without worrying about the implementation details of each library:
+
+- historical TLEs for known satellites (skyfield)
+- propagated orbital parameters hypothetical satellites (skyfield)
+- analytical orbital parameters (hapsira)
+- list of positions
+
+Addtionaly, it provides a straightforward interface for updating used TLEs via [spacetrack](https://www.space-track.org)
+
+Created orbits contain commonly used state variables:
+
+- satellite positions in various frames
+- velocities
+- etc.
+
+## Installation
+1. install the package
+```bash
+pip install spherapy
+```
+2. configure. see [Configuration](#configuration)
+
+## Usage
+- ensure spherapy has been configured, see [Configuration](#configuration)
+- import the spherapy package
+```python
+import spherapy.updater
+import spherapy.timespan
+import spherapy.orbit
+```
+- if using real world satellites; update the desired TLEs (you can also use the TLEs supplied with the package, but these will be out of date).
+	- TLE id's can be found using [NORAD's CelesTrak catalogue search](https://celestrak.org/satcat/search.php)
+```python
+updated_TLEs = spherapy.updater.updateTLEs([25544]) 	#ISS
+TLE_paths = spherapy.updater.getTLEFilePaths([25544], use_packaged=True) 	#ISS
+```
+- set up a timespan
+```python
+t = spherapy.timespan.TimeSpan(datetime.datetime(2024,10,15,0,0,1),'1S','90M')
+```
+- construct an orbit
+	- from a TLE (good practice to update the TLE with the most recent)
+```python
+o = spherapy.orbit.Orbit.fromTLE(t, TLE_paths[0])
+```  
+-	from orbital parameters
+```python
+o = spherapy.orbit.Orbit.fromAnalyticalOrbitalParam(timespan, body='Earth',
+					 a=6978,
+					 ecc=0,
+					 inc=0,
+					 raan=0,
+					 argp=0,
+					 mean_nu=0,
+					 name='My Analytical Orbit',
+					 astrobodies=True)
+```  
+
+#### Full TLE example (for copy paste)
+```
+import datetime
+import spherapy.updater
+import spherapy.timespan
+import spherapy.orbit
+TLE_paths = spherapy.updater.getTLEFilePaths([25544], use_packaged=True) 	#ISS
+t = spherapy.timespan.TimeSpan(datetime.datetime(2024,10,15,0,0,1),'1S','90M')
+o = spherapy.orbit.Orbit.fromTLE(t, TLE_paths[0])
+```
+
+#### Full Analytical exmaple (for copy paste)
+```
+import datetime
+import spherapy.timespan
+import spherapy.orbit
+t = spherapy.timespan.TimeSpan(datetime.datetime(2024,10,15,0,0,1),'1S','90M')
+o = spherapy.orbit.Orbit.fromAnalyticalOrbitalParam(timespan, body='Earth',
+					 a=6978,
+					 ecc=0,
+					 inc=0,
+					 raan=0,
+					 argp=0,
+					 mean_nu=0,
+					 name='My Analytical Orbit',
+					 astrobodies=True)
+```
+
+## SpaceTrack Credentials
+In order to calculate the position of a historical satellite at any given time, spherapy requires [TLE information](https://en.wikipedia.org/wiki/Two-line_element_set) for each satellite which is accurate for the given time period (or 'epoch').  
+TLE data can be obtained from either [Celestrak](https://celestrak.org/) or [Spacetrack](https://www.space-track.org/). 
+Celestrak holds only the most recent TLE data for each satellite, while Spacetrack will provide historical TLE data. spherapy will fall back to using Celestrak if it cannot authenticate access to Spacetrack.  
+In order to use Spacetrack, you must provide your [Spacetrack credentials](https://www.space-track.org/auth/createAccount) to spherapy.
+
+## Configuration
+Configuration for spherapy can either use the default settings, or settings specified in a `spherapy.conf` file.
+
+### Default settings
+If the default settings are used, spherapy will use the system user data directory and expect spacetrack credentials to be stored in the system keyring.  
+The default data directories are listed in [Directories](#directories)
+
+### Custom settings
+Custom settings can be specified in a `spherapy.conf` file.  
+This file can be located either in the system user's config file (described in [Directories](#directories)) or at a location specified by the environment variable `SPHERAPY_CONFIG_DIR`.
+
+The fields of `spherapy.conf` are described below
+```ini
+[credentials]
+SpacetrackUser = None 		# the spacetrack user, if left as "None" will source from system keyring
+SpacetrackPasswd = None 	# the spacetrack password, if left as "None" will source from system keyring
+
+[paths]
+# relative paths are assumed to be relative to the location of this file
+# do not quote path
+TLE_path = ./spherapy/data/TLEs 	# the location where TLE files will be saved, if left empty (""), will default to system user's directory.
+```
+
+### Directories
+If `SPHERAPY_CONFIG_DIR` is not set or `TLE_path` is left empty in `spherapy.conf`, the spherapy default directories will be used:
+
+#### Linux
+- TLE data dir:
+``` bash
+/home/{username}/.local/share/spherapy/TLEs
+```
+- config dir:
+``` bash
+/home/{username}/.config/spherapy/spherapy/{spherapy_version}/
+```
+
+#### OSX
+- TLE data dir:
+``` bash
+/Users/{username}/Library/Application Support/spherapy/TLEs
+```
+- config dir:
+``` bash
+/Users/{username}/Library/Application Support/spherapy/{spherapy_version}/
+```
+
+#### Windows
+- TLE data dir:
+``` bash
+'C:\\Users\\{username}\\AppData\\Local\\spherapy\\TLEs'
+```
+- config dir:
+``` bash
+'C:\\Users\\{username}\\AppData\\Local\\spherapy\\{spherapy_version}'
+```
+
+### Passwords
+By default spherapy will use the system keyring to store the Spacetrack username and credentials (see [SpaceTrack Credentials](#spacetrack-credentials))  
+If a config file is supplied, the credentials in the file will be used.
+
+Credentials can be added to the keyring by running the command (in the terminal, not the python shell)
+```
+spherapy-create-credentials
+```
+
+### Configration File Format
+The configuration file `spherapy.conf` should have the following format:
+```ini
+[credentials]
+SpacetrackUser = None
+SpacetrackPasswd = None
+
+[paths]
+# relative paths are assumed to be relative to the location of this file
+# do not quote path
+TLE_path =
+```
+
+## Data Storage
+- TLEs
+	- TLEs will be stored in the data directory, with a single file for each satellite ID.
+	 `{sat_id}.tle`, containing all historical TLEs for that satellite.
+	- If celestrak is used instead, the file will be saved as a temporary file `{sat_id}.temptle`, which will be overwritten on each fetch from celestrak.

spherapy-0.2.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+spherapy/__init__.py,sha256=v1n13-2Uuy8GEWkB_B5mu2tSkAOVEPVP2eF0GixSPtI,2865
+spherapy/__main__.py,sha256=YOcE__6OgX-e7lJ6UpeGS8Iw5igG0jEraTq8KOqGuDA,374
+spherapy/_version.py,sha256=Dg8AmJomLVpjKL6prJylOONZAPRtB86LOce7dorQS_A,704
+spherapy/orbit.py,sha256=MyRa1U5cEdzP1yhFLbp25T1kHqTpZVnj75Siwfe6vbo,32607
+spherapy/timespan.py,sha256=xc5JEYtDcG4zZdsbdW9lcIX_PXzXzNJ-xGD_bCWJFDs,14438
+spherapy/updater.py,sha256=vJspNTn6fa7qpECFLBWOmpCUVhJs_QBeAMa0JDmnmks,3249
+spherapy/data/TLEs/25544.tle,sha256=D-kndlhtWawbxR8tCU-7QZB1VZxROzutUBgc1ZwO4C0,7873403
+spherapy/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spherapy/util/celestrak.py,sha256=KmcpCCuW30I00FRGBgz7ZUTgQJhGsgSN-LHJ16tJq9s,2273
+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/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.0.dist-info/licenses/LICENSE.md,sha256=9a5OXeKpk6GnCRhlQAPa5JQjl3PaFqseA1p2_DhXEbA,1055
+spherapy-0.2.0.dist-info/METADATA,sha256=485HeliZvVHY_Zvj2TjoaU-VD8737CsVspNjZdqX74I,7756
+spherapy-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+spherapy-0.2.0.dist-info/entry_points.txt,sha256=WpE3jlS6iiug9ZqUrAHQuLEhbDTpbnAtBz8b0yXJJOU,150
+spherapy-0.2.0.dist-info/top_level.txt,sha256=X4rv7pGR9bAfVWOokUyHeDb6Z0jfIQCN6zDfh5f2NK4,9
+spherapy-0.2.0.dist-info/RECORD,,

spherapy-0.2.0.dist-info/WHEEL

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

spherapy-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+spherapy-clear-credentials = spherapy.__main__:clear_credentials
+spherapy-create-credentials = spherapy.__main__:create_credentials

spherapy-0.2.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright © 2025 Robert Mearns
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

spherapy-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+spherapy