astrox-python 0.1.0__tar.gz → 0.2.0__tar.gz

{astrox_python-0.1.0 → astrox_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: astrox-python
-Version: 0.1.0
+Version: 0.2.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
@@ -28,55 +28,60 @@ Description-Content-Type: text/markdown
 
 # astrox-python
 
-Python SDK for the ASTROX Web API.
+astrox-python 是 ASTROX Web API 的 Python SDK。
 
-## Installation
+## 安装
+
+需要 Python 3.10 或更高版本。
 
 ```bash
 pip install astrox-python
 ```
 
-Requires Python 3.10 or later.
-
-## Quickstart
+## 一分钟示例
 
-Propagate a simple Keplerian orbit with J2 perturbations:
+用一组开普勒根数做 J2 传播：
 
 ```python
+import astrox
 from astrox import orbits, propagator
 
+astrox.configure(base_url="http://astrox.cn:8765")
+
 orbit = orbits.keplerian(
     semi_major_axis_m=6778137.0,
     eccentricity=0.001,
-    inclination_deg=28.5,
+    inclination_deg=51.6,
     argument_of_periapsis_deg=0.0,
-    raan_deg=0.0,
-    true_anomaly_deg=0.0,
+    raan_deg=120.0,
+    true_anomaly_deg=45.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",
+    start="2024-01-01T00:00:00.000Z",
+    stop="2024-01-01T00:10:00.000Z",
+    orbit_epoch="2024-01-01T00:00:00.000Z",
     orbit=orbit,
 )
+
+print(f"轨道周期: {period_s:.3f} s")
+print(f"位置/速度采样数: {len(position.cartesian_velocity)}")
 ```
 
-## Documentation
+完整首次运行流程见 [快速上手](docs/getting_started.md)。
 
-- SDK guides and API notes: [`docs/sdk/`](./docs/sdk/)
-- Runnable examples: [`examples/`](./examples/)
+## 文档
 
-## Development
+- 完整文档导航：[docs/README.md](docs/README.md)
+- 可运行示例：[examples/](examples/)
+- 英文快照：[docs/i18n/en/README.md](docs/i18n/en/README.md)
 
-Install from a checkout:
+## 参与开发
 
-```bash
-uv sync --group dev
-uv build --no-build-isolation
-uv run python -m pytest -q tests/sdk
-```
+开发环境搭建与构建步骤见 [CONTRIBUTING.md](docs/CONTRIBUTING.md)。
+
+## 许可
 
-## License
+MIT 许可证，详见 [LICENSE](LICENSE)。
 
-MIT — see [LICENSE](./LICENSE).
+本项目目前处于 Alpha 阶段。

astrox_python-0.2.0/README.md

@@ -0,0 +1,59 @@
+# astrox-python
+
+astrox-python 是 ASTROX Web API 的 Python SDK。
+
+## 安装
+
+需要 Python 3.10 或更高版本。
+
+```bash
+pip install astrox-python
+```
+
+## 一分钟示例
+
+用一组开普勒根数做 J2 传播：
+
+```python
+import astrox
+from astrox import orbits, propagator
+
+astrox.configure(base_url="http://astrox.cn:8765")
+
+orbit = orbits.keplerian(
+    semi_major_axis_m=6778137.0,
+    eccentricity=0.001,
+    inclination_deg=51.6,
+    argument_of_periapsis_deg=0.0,
+    raan_deg=120.0,
+    true_anomaly_deg=45.0,
+)
+
+period_s, position = propagator.j2(
+    start="2024-01-01T00:00:00.000Z",
+    stop="2024-01-01T00:10:00.000Z",
+    orbit_epoch="2024-01-01T00:00:00.000Z",
+    orbit=orbit,
+)
+
+print(f"轨道周期: {period_s:.3f} s")
+print(f"位置/速度采样数: {len(position.cartesian_velocity)}")
+```
+
+完整首次运行流程见 [快速上手](docs/getting_started.md)。
+
+## 文档
+
+- 完整文档导航：[docs/README.md](docs/README.md)
+- 可运行示例：[examples/](examples/)
+- 英文快照：[docs/i18n/en/README.md](docs/i18n/en/README.md)
+
+## 参与开发
+
+开发环境搭建与构建步骤见 [CONTRIBUTING.md](docs/CONTRIBUTING.md)。
+
+## 许可
+
+MIT 许可证，详见 [LICENSE](LICENSE)。
+
+本项目目前处于 Alpha 阶段。

{astrox_python-0.1.0 → astrox_python-0.2.0}/astrox/__init__.py

@@ -4,7 +4,7 @@ Functions are organized by domain modules and can use package-level
 configuration without requiring explicit client management:
 
     import astrox
-    from astrox import access, coverage, components, lighting, orbits, propagator
+    from astrox import access, celestial, catalog, components, coverage, lighting, orbits, propagator, terrain
 
     astrox.configure(base_url="http://custom:8765", timeout=120)
     orbit = orbits.keplerian(...)
@@ -26,7 +26,21 @@ Raw route access is available for advanced callers:
 
 from importlib.metadata import PackageNotFoundError, version
 
-from astrox import access, coverage, components, lighting, orbits, propagator, rocket
+from astrox import (
+    access,
+    astrogator,
+    catalog,
+    cat,
+    celestial,
+    conjunction,
+    components,
+    coverage,
+    lighting,
+    orbits,
+    propagator,
+    rocket,
+    terrain,
+)
 from astrox._http import Client, configure, get_session, raw
 
 try:
@@ -39,11 +53,17 @@ __all__ = [
     "configure",
     "get_session",
     "access",
+    "astrogator",
+    "catalog",
+    "cat",
+    "celestial",
+    "conjunction",
     "coverage",
     "components",
     "lighting",
     "orbits",
     "propagator",
     "rocket",
+    "terrain",
     "raw",
 ]

astrox_python-0.2.0/astrox/astrogator/__init__.py

@@ -0,0 +1,8 @@
+"""Pythonic Astrogator mission-control sequence API."""
+
+from . import _models, _results
+from ._api import run_mcs
+from ._models import *  # noqa: F403
+from ._results import *  # noqa: F403
+
+__all__ = [*_models.__all__, *_results.__all__, "run_mcs"]  # noqa: PLE0604

astrox_python-0.2.0/astrox/astrogator/_api.py

@@ -0,0 +1,60 @@
+"""Public Astrogator RunMCS endpoint."""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+
+from astrox._http import raw
+from astrox.propagator import HpopConfig
+
+from ._models import (
+    EngineConstant,
+    EntityPath,
+    MCSSegment,
+    _mission_wire,
+)
+from ._results import RunMCSResult, run_mcs_result_from_wire
+
+
+def _entities_to_wire(values: Sequence[EntityPath] | None) -> list[dict[str, object]] | None:
+    if values is None:
+        return None
+    if isinstance(values, (str, bytes)) or not isinstance(values, Sequence):
+        raise TypeError("entities must be a sequence of astrogator EntityPath values")
+    items = tuple(values)
+    if not all(isinstance(item, EntityPath) for item in items):
+        raise TypeError("entities must be a sequence of astrogator EntityPath values")
+    return [item.to_wire() for item in items]
+
+
+def run_mcs(
+    main_sequence: Sequence[MCSSegment],
+    *,
+    central_body: str = "Earth",
+    out_czml_frame_name: str = "INERTIAL",
+    compute_czml_positions: bool | None = None,
+    entities: Sequence[EntityPath] | None = None,
+    propagators: Sequence[HpopConfig] | None = None,
+    engine_models: Sequence[EngineConstant] | None = None,
+    text: str | None = None,
+) -> RunMCSResult:
+    """Run an ASTROX Astrogator mission-control sequence."""
+
+    payload = _mission_wire(
+        central_body=central_body,
+        main_sequence=main_sequence,
+        compute_czml_positions=compute_czml_positions,
+        out_czml_frame_name=out_czml_frame_name,
+        text=text,
+        propagators=propagators,
+        engine_models=engine_models,
+    )
+    entity_values = _entities_to_wire(entities)
+    if entity_values is not None:
+        payload["Entities"] = entity_values
+
+    result = raw.post("/Astrogator/RunMCS", json=payload)
+    return run_mcs_result_from_wire(result)
+
+
+__all__ = ["run_mcs"]