Commit Graph

158 Commits

Author SHA1 Message Date
ApsisRS contributors 77425a6e9d docs: record the benchmark results in the README 2026-10-02 13:06:37 +08:00
ApsisRS contributors f2810a5c52 chore: resolve the pedantic clippy lints across the workspace 2026-10-02 13:06:16 +08:00
ApsisRS contributors fcb53c4349 docs: split the vendored MathJax readme into an English and a Chinese file
The repository keeps documentation as an X.md and an X.zh.md pair, so the
note that records the vendor, version and checksum follows the same shape.
2026-10-02 12:49:46 +08:00
ApsisRS contributors f48c4d9bd7 docs: render formulas as math with a vendored MathJax
The rustdoc in this toolchain does not parse math (its pulldown-cmark options
omit ENABLE_MATH, `--mathjax` and `html_mathjax` are gone, and a `$$...$$`
paragraph is emitted verbatim). Display formulas were therefore written as
```text code blocks, which the request asked to replace with math syntax.

MathJax 3.2.2 (tex-svg-full, Apache-2.0) is vendored under
docs/vendor/mathjax so the rendered pages need no network access.
docs/mathjax.html loads it from the documentation root computed from rustdoc's
own static file prefix; crates/apsis-rs/build.rs copies it into that root, and
scripts/build-docs.sh makes the copy reliable. Each formula is wrapped in a
raw HTML `<div>` so the markdown layer leaves the LaTeX untouched, because
markdown would otherwise consume the backslashes in `\\\\`, `\,`, `\!` and
`\_`.

All 54 formula blocks (27 formulas, English and Chinese) become `$$...$$`;
the 22 command, 2 diagram and 2 scenario-format blocks stay as ```text.
2026-10-02 12:28:20 +08:00
ApsisRS contributors 95cb3309f2 docs: resolve the facade re-export links and check the default-feature docs
The facade module doc linked the re-exported crates with intra-doc links,
which only resolve when the matching feature is on. With the default
feature set, cargo doc reported ten unresolved links. The names are now
plain code spans, so both builds are clean, and CI checks the default
feature set as well.
2026-10-02 08:50:32 +08:00
ApsisRS contributors d37ca8f919 docs: remove a repeated Chinese paragraph in the routing module doc 2026-10-02 02:18:49 +08:00
ApsisRS contributors 655e214a5e docs: repair partial translations, sentence splits and duplicated blocks
The bilingual sweep had left some blocks with only their last paragraph
translated, a few with the Chinese inserted inside an English sentence,
and some with a repeated paragraph from a re-applied table. A rewrite of
the coverage checks found them; this fixes every block and restores the
comment separators that a cleanup pass had emptied.
2026-10-02 02:18:15 +08:00
ApsisRS contributors 92ad0bcd1c docs: bilingual comments for the sim tests 2026-10-02 02:00:56 +08:00
ApsisRS contributors 1526928097 docs: bilingual comments for the ops tests 2026-10-02 02:00:32 +08:00
ApsisRS contributors ad05381d61 docs: bilingual comments for the network tests 2026-10-02 01:59:43 +08:00
ApsisRS contributors 55a1449a12 docs: finish the rf test comments 2026-10-02 01:58:31 +08:00
ApsisRS contributors 8193b3aade docs: finish the rf test comments 2026-10-02 01:57:45 +08:00
ApsisRS contributors 2fe3fad27a docs: bilingual comments for the rf tests 2026-10-02 01:57:31 +08:00
ApsisRS contributors 4f90474610 docs: bilingual comments for the orbit tests 2026-10-02 01:56:29 +08:00
ApsisRS contributors 1ffba97a14 docs: bilingual comments for the foundation and physics tests 2026-10-02 01:55:40 +08:00
ApsisRS contributors a4f5a30aa9 docs: bilingual comments for the benchmark examples 2026-10-02 01:54:29 +08:00
ApsisRS contributors 2190e1f81f docs: bilingual comments for the integration examples 2026-10-02 01:53:47 +08:00
ApsisRS contributors d911a4bb0a docs: bilingual comments for the dump examples 2026-10-02 01:52:26 +08:00
ApsisRS contributors 57316092eb docs: complete the bilingual module docs for the ops and sim layers 2026-10-02 01:51:22 +08:00
ApsisRS contributors b4f61085ce docs: bilingual module docs for the ops and sim layers 2026-10-02 01:49:32 +08:00
ApsisRS contributors 5e521a447b docs: bilingual module docs for the network layer 2026-10-02 01:49:08 +08:00
ApsisRS contributors 800a1b02f8 docs: bilingual module docs for the rf layer 2026-10-02 01:48:55 +08:00
ApsisRS contributors 7bb3138229 docs: bilingual module docs for the orbit layer 2026-10-02 01:47:49 +08:00
ApsisRS contributors c407739763 docs: bilingual module docs for the physics layer 2026-10-02 01:46:35 +08:00
ApsisRS contributors 4ac50e98d7 docs: bilingual module docs for the foundation layer 2026-10-02 01:45:27 +08:00
ApsisRS contributors 82a5a418a8 docs: bilingual comments for the validation tools
Also makes the table generators emit the bilingual module docs, so a
regenerated table matches the committed one.
2026-10-02 01:44:36 +08:00
ApsisRS contributors 0e3d735935 docs: bilingual comments for the orbit validation scripts 2026-10-02 01:42:39 +08:00
ApsisRS contributors 8e2a956fa5 docs: bilingual comments for the coverage and link validation scripts 2026-10-02 01:41:57 +08:00
ApsisRS contributors 3253397501 docs: bilingual comments for the atmosphere and coordinate validation scripts 2026-10-02 01:41:29 +08:00
ApsisRS contributors fd829e797f docs: bilingual comments for the CI workflow, manifests and scripts
Extends the checker to the module level `//!` docs, the tests, the
examples, and the non-Rust prose comments in the workflow, the manifests
and the shell and Python scripts.
2026-10-02 01:40:39 +08:00
ApsisRS contributors 26a21a23bd docs: bilingual comments for the IAU 2000 frames and Earth rotation
The Delaunay and planetary arguments, the precession, nutation, polar
motion and Earth rotation angles, and the TEME and terrestrial matrices.
This completes the bilingual sweep: every comment block in the workspace
now carries its Chinese counterpart.
2026-10-02 01:35:40 +08:00
ApsisRS contributors e9d4690858 docs: bilingual comments for the Delaunay arguments 2026-10-02 01:32:09 +08:00
ApsisRS contributors 5773399304 docs: bilingual comments for the antenna, doppler, interference and noise crates 2026-10-02 01:31:41 +08:00
ApsisRS contributors 3c432b9112 docs: bilingual comments for the link budget and antenna patterns 2026-10-02 01:29:47 +08:00
ApsisRS contributors cfe8d72bb2 docs: bilingual comments for the atmosphere attenuation models
The P.838 rain curves, the P.676 gaseous lines, the P.839 isotherm table
and the P.835 layered refraction.
2026-10-02 01:28:58 +08:00
ApsisRS contributors f3cf18df41 docs: bilingual comments for access, coverage, isl and routing
This completes the network layer.
2026-10-02 01:26:58 +08:00
ApsisRS contributors 295ba16d0d docs: bilingual comments for the access finder and pass summary 2026-10-02 01:25:53 +08:00
ApsisRS contributors 5857c44492 docs: bilingual comments for mesh and routing 2026-10-02 01:25:10 +08:00
ApsisRS contributors c442acc6e5 docs: bilingual comments for handover and topology 2026-10-02 01:24:45 +08:00
ApsisRS contributors 891fe0b37b docs: bilingual comments for the simulation layer
The event queue and identifiers, the output records and trace, the scenario
build and parse, and the run facade, including the plain comments inside
the functions.
2026-10-02 01:23:34 +08:00
ApsisRS contributors 30c9a348c3 docs: bilingual comments for the decibel and gain scales 2026-10-02 01:16:30 +08:00
ApsisRS contributors 99807cb5e6 docs: bilingual comments for the error types, links and mesh
The error modules across the remaining crates share a shape, so one table
covers them all. Also the inter-satellite link geometry and the mesh
connectivity analysis, including the Menger and Kosaraju notes.
2026-10-02 01:14:59 +08:00
ApsisRS contributors e41e2c77bb docs: extend the bilingual sweep into routing, topology, access and rf
A translation table for the sentences that recur across the error types
and the simple accessors let the same wording be applied everywhere at
once, which both keeps the Chinese consistent and covers a hundred and
twenty-nine sites in a single pass. Routing, topology, access and the radio
frequency crates are now part of the sweep.
2026-10-02 01:10:40 +08:00
ApsisRS contributors 7e71b6d6ca docs: bilingual comments for apsis-scheduler
The layer is complete at three hundred and sixty two blocks across the
resource, task, schedule, conflict and scheduler crates, including the
swept search and the improvement pass.
2026-10-02 01:06:17 +08:00
ApsisRS contributors bbd3cb0c3f docs: bilingual comments for apsis-conflict 2026-10-02 01:04:12 +08:00
ApsisRS contributors 175abb3f68 docs: bilingual comments for apsis-schedule 2026-10-02 01:03:18 +08:00
ApsisRS contributors 0a221e23b7 docs: bilingual comments for apsis-task 2026-10-02 01:01:36 +08:00
ApsisRS contributors f26a90bc96 docs: bilingual comments for apsis-resource
Seventy-five comment blocks across the error kinds, the resource model
and the window algebra. The English is unchanged and the Chinese follows
under a blank doc line, as the glossary sets out.
2026-10-02 01:00:22 +08:00
ApsisRS contributors f5b1952555 docs: record the benchmark method and the measurements
Three measurements, each answering a different question: what one call
costs, how the cost grows with size, and what the other cores save. The
method states the three rules the tools follow, no warm-up, best of several
runs, and cost per unit rather than an absolute figure, so a reader can
reproduce and judge.

The findings are that the numerical kernels are linear and parallelise
well, a day over two thousand satellites costs 0.7 seconds on one core and
81 milliseconds on sixteen, and that interpolation is about ten times
cheaper than propagation. Two combined operations are limited by their
algorithm: greedy planning is quadratically serial, and the duplicate
check on edge insertion squares that quadratic, so threading helps neither.
Eight threads is recommended, since efficiency falls to about half at
sixteen.
2026-10-02 00:57:20 +08:00
ApsisRS contributors 5c11b60069 docs: bilingual comments for the foundation, physics and orbit layers
Applies the glossary across apsis-math, apsis-time, apsis-leap,
apsis-coord, apsis-geodesy and the five orbit crates that were already
implemented, plus apsis-ephemeris, apsis-maneuver and apsis-orbit. Five
hundred and seven comment blocks now carry the English paragraph and the
Chinese one.

The checker learned to skip a comment that is only a formula, since a bare
symbol has no prose to translate and repeating it in Chinese would be noise.
The SGP4 cross-check still passes, so nothing in the numerical path moved.
2026-10-02 00:53:42 +08:00