astrox-python 0.1.0__py3-none-any.whl

astrox/rocket.py

@@ -0,0 +1,82 @@
+"""Rocket analysis functions."""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from numbers import Real
+from typing import Any
+
+from astrox._http import raw
+
+__all__ = [
+    "landing_zone",
+]
+
+
+def _number_sequence_to_list(value: Sequence[float], *, parameter: str) -> list[float]:
+    if isinstance(value, (str, bytes)) or not isinstance(value, Sequence):
+        raise TypeError(f"{parameter} must be a sequence of numbers")
+    items = list(value)
+    if not all(isinstance(item, Real) and not isinstance(item, bool) for item in items):
+        raise TypeError(f"{parameter} must be a sequence of numbers")
+    return items
+
+
+def landing_zone(
+    *,
+    launch_longitude_deg: float,
+    launch_latitude_deg: float,
+    launch_height_m: float,
+    impact_longitude_deg: float,
+    impact_latitude_deg: float,
+    impact_height_m: float,
+    zone_xys_km: Sequence[float],
+) -> dict[str, Any]:
+    """Compute rocket landing-zone boundary geodetic coordinates.
+
+    Parameters match the ASTROX ``/LandingZone`` endpoint. ``zone_xys_km`` is a
+    flat sequence of local downrange/crossrange offsets in kilometres, given in
+    ``[+X1, +Y1, +X2, +Y2, ...]`` pairs.
+
+    Cross-validation shows ASTROX builds a local right-handed frame at the
+    impact point: ``+X`` is the southward-facing member of the launch-to-impact
+    geodesic azimuth at the impact point and its supplement, and ``+Y`` is
+    ``+X`` rotated 90 degrees clockwise. For cardinal tracks this coincides with
+    the OpenAPI "forward/right" description; for diagonal tracks it does not.
+
+    The function returns the raw ASTROX response dict, including ``IsSuccess``,
+    ``Message``, and ``cartographicDegrees``.
+
+    Example:
+        >>> from astrox import rocket
+        >>> result = rocket.landing_zone(
+        ...     launch_longitude_deg=100.0,
+        ...     launch_latitude_deg=30.0,
+        ...     launch_height_m=0.0,
+        ...     impact_longitude_deg=101.0,
+        ...     impact_latitude_deg=30.5,
+        ...     impact_height_m=100.0,
+        ...     zone_xys_km=[1.0, 0.5, -1.0, 0.5, -1.0, -0.5, 1.0, -0.5],
+        ... )
+        >>> result["IsSuccess"]
+        True
+    """
+    zone_xys = _number_sequence_to_list(zone_xys_km, parameter="zone_xys_km")
+    if len(zone_xys) % 2 != 0:
+        raise ValueError("zone_xys_km must contain an even number of values")
+
+    payload: dict[str, Any] = {
+        "FaSheDian": [
+            launch_longitude_deg,
+            launch_latitude_deg,
+            launch_height_m,
+        ],
+        "LuoDian": [
+            impact_longitude_deg,
+            impact_latitude_deg,
+            impact_height_m,
+        ],
+        "ZoneXYs": zone_xys,
+    }
+
+    return raw.post("/LandingZone", json=payload)

astrox_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: astrox-python
+Version: 0.1.0
+Summary: Python SDK for the ASTROX Web API.
+Project-URL: Homepage, https://github.com/Mtrya/astrox-python
+Project-URL: Repository, https://github.com/Mtrya/astrox-python.git
+Project-URL: Issues, https://github.com/Mtrya/astrox-python/issues
+Project-URL: Documentation, https://github.com/Mtrya/astrox-python/tree/main/docs
+Author-email: Mtrya <erchanmion20@outlook.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: astrodynamics,astrox,orbit,propagation,sdk,space
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: requests>=2.34.2
+Description-Content-Type: text/markdown
+
+# astrox-python
+
+Python SDK for the ASTROX Web API.
+
+## Installation
+
+```bash
+pip install astrox-python
+```
+
+Requires Python 3.10 or later.
+
+## Quickstart
+
+Propagate a simple Keplerian orbit with J2 perturbations:
+
+```python
+from astrox import orbits, propagator
+
+orbit = orbits.keplerian(
+    semi_major_axis_m=6778137.0,
+    eccentricity=0.001,
+    inclination_deg=28.5,
+    argument_of_periapsis_deg=0.0,
+    raan_deg=0.0,
+    true_anomaly_deg=0.0,
+)
+
+period_s, position = propagator.j2(
+    start="2026-01-01T00:00:00Z",
+    stop="2026-01-01T01:00:00Z",
+    orbit_epoch="2026-01-01T00:00:00Z",
+    orbit=orbit,
+)
+```
+
+## Documentation
+
+- SDK guides and API notes: [`docs/sdk/`](./docs/sdk/)
+- Runnable examples: [`examples/`](./examples/)
+
+## Development
+
+Install from a checkout:
+
+```bash
+uv sync --group dev
+uv build --no-build-isolation
+uv run python -m pytest -q tests/sdk
+```
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

astrox_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+astrox/__init__.py,sha256=a-QdWpMqbGR4ZYqJ2M_tSaQv5-YlmnmhUAcCpuQ8RnI,1283
+astrox/_http.py,sha256=ZZDkJ6qPG4VbMDRZO7xonIib88aYS6PPTVRxRYwXU3A,15606
+astrox/access.py,sha256=pjyCher_yQNmkoojf2sWpG1HRDnLLK9gI90jM1iEoTo,5817
+astrox/exceptions.py,sha256=apClRT1r-N3XY1ibXxkW3oxpsJgiHos4tC0cMJ8eBRk,2592
+astrox/lighting.py,sha256=aWMty64rU3wv1H1Q5q-yXG5mINbIY31omyd-pjdNaVs,3876
+astrox/orbits.py,sha256=scbs5EsMytlP8cFoDF3UGqNqgROYR5CfGlsRz7kpDs4,14996
+astrox/propagator.py,sha256=igdFZFz2kDdhKtVjTDziMiY99jdBjfo35MNnfITgOB0,37471
+astrox/rocket.py,sha256=tb6wXc4bZ0EMAd9bVzva_7k3I9S2lsYA7Q2RD6byqfk,2755
+astrox/components/__init__.py,sha256=X7Owt7Ou5tRShjucx9QkYPF-tEYJ0bMrxBRhw61LC6I,4455
+astrox/components/_axes.py,sha256=ZabN28oH77_3kqU2jFBfqxPh_5GYa3XAp-SU9L8btC0,15642
+astrox/components/_common.py,sha256=EejS6mxPojEm-KLD3T3eB8IlkPA4i7FGNM8-IjS00pk,4564
+astrox/components/_constraints.py,sha256=6WUNCQsy5WpXoEr7PJgeH_zQkIZolPYGA0-z9BrD2pw,4692
+astrox/components/_objects.py,sha256=wl61rFCY5jigdNPgjO6TLLtZevOUfKEWYXKc2BRZT0U,5805
+astrox/components/_positions.py,sha256=9w1AbVkM0_Fqw8SED_PTxTvM9Ro4Lo9qXB8b-JrXkqw,23345
+astrox/components/_rotations.py,sha256=BojDBogMkD3MYG2pRDRSm2zvfTommXtzybVX_UU-h3c,3039
+astrox/components/_sensors.py,sha256=0jQRgLewUmF1Kl7q_8l17-wAjrrkfreF763PIIU8dmQ,4216
+astrox/components/_vgt.py,sha256=gU60Sc6fluUn04LAG_c1OUnMOz3TK-MhTexiLhm5qRc,10617
+astrox/coverage/__init__.py,sha256=h5DpTK7j4CJdtfP7wGZLkS7VO_tVdI0cYj4O-My8TQw,853
+astrox/coverage/_core.py,sha256=o5qV5dpaAEIbTUJituomx6sqMkFX9eNVGuCVcvC4hrI,18607
+astrox/coverage/_fom.py,sha256=QumQrm6oTexShYqcc_-lPQmxbJgK1AZQepgthRh0Kqk,3924
+astrox/coverage/coverage_time.py,sha256=RaTmtcFdawAkTXoQNntVMzCl4nN2JL8iCJ3EtYwfCck,2684
+astrox/coverage/number_of_assets.py,sha256=Bf1OQRu1r9lunyARyQoV4x7KetkgY_7OMNcEcDCeS64,5187
+astrox/coverage/response_time.py,sha256=yLnv8eEDL6CS0PJHC1JIKBCoOachOwo3m8dNoHH3HfQ,5164
+astrox/coverage/revisit_time.py,sha256=R5vF2egixCF9elvsGYXzpgWbD5lfcQW8uZqi1ifIDX8,5155
+astrox/coverage/simple_coverage.py,sha256=ZPj3HrP3M59rG47pz4eHt1rq-vTlk-oZ7c2ZBmFsz1U,4992
+astrox_python-0.1.0.dist-info/METADATA,sha256=nYmEBu5MJlV82ndyO0bRLFbpnVlvHJbexWtCSyTFy_g,2179
+astrox_python-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+astrox_python-0.1.0.dist-info/licenses/LICENSE,sha256=Fbt55lCQnv_n5yGhbG_VDlowjaV_FPHBQWsJIyuBpDk,1062
+astrox_python-0.1.0.dist-info/RECORD,,

astrox_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

astrox_python-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mtrya
+
+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.