astro-pi-orbit 2.0.0__tar.gz

astro_pi_orbit-2.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Raspberry Pi Foundation
+
+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.
+

astro_pi_orbit-2.0.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.1
+Name: astro_pi_orbit
+Version: 2.0.0
+Summary: Module for interfacing with the Astro Pi
+Author-email: Ben Nuttall <ben@bennuttall.com>, George Boukeas <boukeas@gmail.com>, Geraint Ballinger <G3zz@users.noreply.github.com>
+License: MIT License
+        
+        Copyright (c) 2024 Raspberry Pi Foundation
+        
+        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.
+        
+        
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: skyfield
+
+# astro_pi_orbit
+
+The `astro_pi_orbit` library provides functionality to assist Astro Pi Mission Space Lab participants in working with orbital data.
+
+Documentation is available at [docs](./docs).
+
+## Contributing
+
+We welcome all contributions!
+Please install and run the dependencies in `requirements-dev.txt`, and run `pre-commit` prior to opening a PR. On Unix, `pre-commit` can be installed by running the following:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+

astro_pi_orbit-2.0.0/README.md

@@ -0,0 +1,16 @@
+# astro_pi_orbit
+
+The `astro_pi_orbit` library provides functionality to assist Astro Pi Mission Space Lab participants in working with orbital data.
+
+Documentation is available at [docs](./docs).
+
+## Contributing
+
+We welcome all contributions!
+Please install and run the dependencies in `requirements-dev.txt`, and run `pre-commit` prior to opening a PR. On Unix, `pre-commit` can be installed by running the following:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+

astro_pi_orbit-2.0.0/astro_pi_orbit/__init__.py

@@ -0,0 +1,9 @@
+from .telemetry import ISS, de421, de440s, ephemeris
+
+__version__ = "2.0.0"
+__all__ = [
+    "ISS",
+    "de421",
+    "de440s",
+    "ephemeris",
+]

astro_pi_orbit-2.0.0/astro_pi_orbit/telemetry.py

@@ -0,0 +1,87 @@
+import os
+from pathlib import Path
+
+from skyfield.api import Loader, load
+
+_tle_dir: Path = Path(os.environ.get("TLE_DIR", Path.home()))
+print("_TLE_DIR", _tle_dir)
+_tle_filename = "iss.tle"
+_tle_url = "http://celestrak.com/NORAD/elements/stations.txt"
+
+_bsp_dir = os.environ.get("BSP_DIR", Path.home())
+print("_BSP_DIR", _bsp_dir)
+_bsp_421_filename = "de421.bsp"
+_bsp_440s_filename = "de440s.bsp"
+
+_timescale = load.timescale()
+
+
+def _load_iss():
+    """
+    Retrieves ISS telemetry data from a local or remote TLE file and
+    returns a Skyfield EarthSatellite object corresponding to the ISS.
+    """
+    loader = Loader(_tle_dir, verbose=False)
+    try:
+        # find telemetry data locally
+        satellites = loader.tle_file(_tle_filename)
+    except FileNotFoundError:
+        pass
+    else:
+        iss = next((sat for sat in satellites if sat.name == "ISS (ZARYA)"), None)
+        if iss is None:
+            raise RuntimeError(
+                f"Unable to retrieve ISS TLE data from {loader.path_to(_tle_filename)}"
+            )
+        return iss
+
+    try:
+        # find telemetry data remotely
+        satellites = loader.tle_file(_tle_url)
+        Path(_tle_dir / Path(_tle_url).name).rename(_tle_dir / _tle_filename)
+    except Exception as e:
+        print(e)
+        pass
+    else:
+        iss = next((sat for sat in satellites if sat.name == "ISS (ZARYA)"), None)
+        if iss is None:
+            raise RuntimeError(f"Unable to retrieve ISS TLE data from {_tle_url}")
+        return iss
+
+    raise FileNotFoundError(
+        "Unable to retrieve ISS TLE data: "
+        + f"cannot find {loader.path_to(_tle_filename)} or download {_tle_url}."
+    )
+
+
+def load_iss():
+    ISS = _load_iss()
+    # bind the `coordinates` function to the ISS object as a method
+    setattr(ISS, "coordinates", coordinates.__get__(ISS, ISS.__class__))
+    return ISS
+
+
+def coordinates(satellite):
+    """
+    Return a Skyfield GeographicPosition object corresponding to the  Earth
+    latitude and longitude beneath the current celestial position of the ISS.
+
+    See: rhodesmill.org/skyfield/api-topos.html#skyfield.toposlib.GeographicPosition
+    """
+    return satellite.at(_timescale.now()).subpoint()
+
+
+def load_ephemeris(bsp_filename):
+    loader = Loader(_bsp_dir, verbose=False)
+    return loader(bsp_filename)
+
+
+# create ISS as a Skyfield EarthSatellite object
+# See: rhodesmill.org/skyfield/api-satellites.html#skyfield.sgp4lib.EarthSatellite
+ISS = load_iss
+
+
+# Expose ephemeris in the API
+de421 = load_ephemeris(_bsp_421_filename)
+de440s = load_ephemeris(_bsp_440s_filename)
+ephemeris = de421

astro_pi_orbit-2.0.0/astro_pi_orbit.egg-info/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.1
+Name: astro_pi_orbit
+Version: 2.0.0
+Summary: Module for interfacing with the Astro Pi
+Author-email: Ben Nuttall <ben@bennuttall.com>, George Boukeas <boukeas@gmail.com>, Geraint Ballinger <G3zz@users.noreply.github.com>
+License: MIT License
+        
+        Copyright (c) 2024 Raspberry Pi Foundation
+        
+        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.
+        
+        
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: skyfield
+
+# astro_pi_orbit
+
+The `astro_pi_orbit` library provides functionality to assist Astro Pi Mission Space Lab participants in working with orbital data.
+
+Documentation is available at [docs](./docs).
+
+## Contributing
+
+We welcome all contributions!
+Please install and run the dependencies in `requirements-dev.txt`, and run `pre-commit` prior to opening a PR. On Unix, `pre-commit` can be installed by running the following:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+

astro_pi_orbit-2.0.0/astro_pi_orbit.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+astro_pi_orbit/__init__.py
+astro_pi_orbit/telemetry.py
+astro_pi_orbit.egg-info/PKG-INFO
+astro_pi_orbit.egg-info/SOURCES.txt
+astro_pi_orbit.egg-info/dependency_links.txt
+astro_pi_orbit.egg-info/requires.txt
+astro_pi_orbit.egg-info/top_level.txt

astro_pi_orbit-2.0.0/astro_pi_orbit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

astro_pi_orbit-2.0.0/astro_pi_orbit.egg-info/requires.txt

@@ -0,0 +1 @@
+skyfield

astro_pi_orbit-2.0.0/astro_pi_orbit.egg-info/top_level.txt

@@ -0,0 +1 @@
+astro_pi_orbit

astro_pi_orbit-2.0.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "astro_pi_orbit"
+description = "Module for interfacing with the Astro Pi"
+dynamic = ["version"]
+authors = [
+  { name="Ben Nuttall", email="ben@bennuttall.com" },
+  { name="George Boukeas", email="boukeas@gmail.com" },
+  { name="Geraint Ballinger", email="G3zz@users.noreply.github.com" }
+]
+license = {file="LICENSE"}
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent"
+]
+dependencies = [
+  "skyfield"
+]
+
+[tool.setuptools]
+packages = ["astro_pi_orbit"]
+
+[tool.setuptools.dynamic]
+version = {attr = "astro_pi_orbit.__init__.__version__"}
+
+
+# Configure static checkers/tools
+[tool.isort]
+atomic = true
+line_length = 88
+profile = "black"
+skip_gitignore = true
+src_paths = ["astro_pi_orbit", "test"]
+skip_glob = ["test/resources", "venv", "dist", "site", "docs", "scripts"]
+
+[tool.black]
+line-length = 88
+target-version = ['py39']
+include = '\.pyi?$'
+extend-exclude = '''
+(
+  ^/test/resources
+)
+'''
+
+[tool.bandit]
+skips = ["B101", "B404"]
+exclude = ["test/resources"]
+

astro_pi_orbit-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+