Repository navigation
Update the JOSS paper and reviewer-facing docs for the v1.0 review - #418
Merged
Merged
Conversation
…per from main The wgs84 entry carried inline % comments that bibtex-ruby rejects, which is the editorialbot failure on openjournals/joss-reviews#11377. The rest of the file is tidied while it is open: groves had no year and a local Zotero path, gtsam was an @Article whose journal was a university, anom-ukf's DOI was a URL, anom-pf had empty fields where its DOI and pages belong, and nalgebra was uncited and pointed at the nav-types repository. Canciani & Raquet (2017) is added for the RBPF. The Draft PDF workflow watched a joss branch the review no longer uses; it now builds on pull requests and pushes to main that touch papers/joss/. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The paper described the v0.3 code. It named modules that no longer exist, said closed loop ran a 15-state UKF when the ESKF is the default, listed three CLI modes and two crates, cited the World Magnetic Model for a dipole, and claimed processed datasets were archived in a repository that tracks none. It was also 2,521 words against JOSS's 1,750. The new text is 1,292 words. It retitles the paper and describes the four filters behind one trait, the event-stream separation of scheduling and fault injection, and the zero-panic and frame-check design. It replaces the dataset claim with what can be verified: the test suite, the CI accuracy gate and the conf/ recipes. The AI disclosure now matches the commit history reviewers can see. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README's install line named strapdown-rs, a legacy crate at 0.4.0, and told users to cargo install a strapdown-sim that has never been published. Its badges pointed at the same wrong crate, it linked a LOGGING.md that does not exist, advertised a dataset the repository does not track, and called dead reckoning open loop. It also never said how to run the tests or where to ask for help, both of which the reviewer checklist asks for. Installation is now from git until v1.0.0 reaches crates.io at acceptance. The README gains a statement of need, a quick start that runs as written on a synthetic trajectory, test instructions, and contributing and support pointers. CODE_OF_CONDUCT.md, issue templates and CITATION.cff are added. core/README.md and the analysis package description lose their stale and placeholder text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…nverges strapdown-sim pf with no flags diverged on a 10-minute synthetic trajectory and stopped at its 500 m/s speed check. Both shipped example configs that run the particle filter, particle_filter_comparison.yaml and parallel_example.toml, did the same, because neither sets horizontal_process_noise_std_m. The simulator inherited the library's default, Canciani & Raquet's zero (eq. 19), which the docs already said diverges with GNSS-rate fixes on MEMS data. A reviewer's first particle-filter run would have failed. The CLI flag and the [particle_filter] section now default to 1 m/sqrt(s) on both channels (sim::DEFAULT_PF_HORIZONTAL_PROCESS_NOISE_STD_M), which is what every conf/ recipe sets. RbpfConfig keeps the paper's zero as the library default, so the filter still means what its module docs say. A test holds the CLI and config defaults equal and non-zero. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The installation section incorrectly says Rust is the only requirement despite the simulator’s default native build prerequisites.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Updates the JOSS submission and reviewer-facing documentation for the v1.0 review, while correcting unstable particle-filter defaults.
Changes:
- Rewrites the JOSS paper, bibliography, citation metadata, and PDF workflow.
- Expands contributor, support, installation, and issue-reporting documentation.
- Defaults simulator RBPF horizontal process noise to 1 m/√s while preserving the library default.
| File | Description |
|---|---|
sim/src/main.rs |
Applies and tests the CLI particle-filter default. |
README.md |
Rewrites project and reviewer-facing documentation. |
papers/README.md |
Documents the active JOSS review workflow. |
papers/joss/paper.md |
Rewrites the JOSS manuscript for v1.0. |
papers/joss/paper.bib |
Corrects and expands bibliography metadata. |
core/src/sim.rs |
Defines the simulator-specific RBPF default. |
core/src/rbpf.rs |
Clarifies the library/simulator default distinction. |
core/README.md |
Updates crate capabilities and terminology. |
CODE_OF_CONDUCT.md |
Adds conduct and reporting guidance. |
CLAUDE.md |
Records the revised RBPF default convention. |
CITATION.cff |
Adds software citation metadata. |
book/src/filters/rbpf.md |
Updates documented simulator defaults. |
analysis/pyproject.toml |
Replaces the placeholder package description. |
.github/workflows/draft-pdf.yml |
Runs paper builds on relevant PRs and main. |
.github/ISSUE_TEMPLATE/question.md |
Adds a support template. |
.github/ISSUE_TEMPLATE/config.yml |
Adds issue-form documentation links. |
.github/ISSUE_TEMPLATE/bug_report.md |
Adds a structured bug template. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Without --no-noise, strapdown-sim syn writes sensor records with no truth columns. The kinematic truth comes only from a --no-noise run. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
'Rust is the only hard requirement' covered the simulator install below it. strapdown-sim enables plotting by default, and that feature builds freetype from source, which needs a C/C++ compiler and cmake. The requirements are now stated per install: the library needs only Rust, and the simulator's needs are spelled out where it is installed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README called the default filter 15-state. strapdown-sim estimates a barometric bias by default, so cl runs 16 error states unless --no-estimate-baro-bias is given. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A duty cycle with no start phase begins in its off window, so --on-s 100 --off-s 50 denies GNSS for the first 50 s, then gives 100 s of fixes. The comment had the order reversed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Updates the JOSS paper and the reviewer-facing parts of the repository for the review that opened at openjournals/joss-reviews#11377. The book overhaul (#383) follows in a separate PR stacked on this one.
Paper (
papers/joss/)BibTeX now parses. The
%comments in thewgs84entry are what failed editorialbot. Every entry was checked withbibtex-ruby, the parser editorialbot uses, and all 10 load.grovesgains its year,gtsambecomes the tech report it is, and the DOIs are bare.anom-pfhas its DOI and pages (10.33012/2026.20618, pp. 399–410). Canciani & Raquet (2017) is added. The uncitednalgebraentry is removed.Rewritten for v1.0. The paper drops from 2,521 to 1,292 words (JOSS allows 750–1,750). New title: strapdown-rs: Strapdown inertial navigation and GNSS-degradation simulation in Rust. Claims that no longer matched the code are fixed:
strapdownandfiltermodulesconf/recipesThe AI disclosure now matches the Claude Code and Copilot-agent commits visible in the history.
Draft PDF workflow builds on PRs and pushes to
mainthat touchpapers/joss/. It used to trigger only on ajossbranch the review no longer uses.Reviewer checklist items
cargo add strapdown-rs(a legacy 0.4.0 crate) andcargo install strapdown-sim(never published). It now installs from git until v1.0.0 is published at acceptance.LOGGING.mdlink, the untracked-dataset claim, and "open loop" used to mean dead reckoning.CODE_OF_CONDUCT.md(Contributor Covenant 2.1), bug and question issue templates, andCITATION.cff.core/README.mdand the placeholder description inanalysis/pyproject.toml.One code fix
strapdown-sim pfwith default settings diverged. On a 10-minutesyntrajectory it stopped at the 500 m/s speed check. Both shipped example configs that run the particle filter did the same. The cause was the inheritedhorizontal_process_noise_std_m = 0(the paper's eq. 19), which the docs already said diverges on MEMS data. The simulator and its config now default to 1 m/√s, which is what everyconf/recipe sets.RbpfConfigkeeps the paper's zero as the library default. A new test holds the CLI and config defaults equal and non-zero.Verification
cargo fmt-check,cargo lint,cargo lint-min,cargo test --workspace --all-featuresandcargo test-minall pass.syn,clwith a duty-cycle outage,cl --filter ukf,drandpfall ran on a synthetic trajectory.examples/configs/particle_filter_comparison.yamlruns.cargo add strapdown-core --git …builds and runs in a freshcargo newproject.pandoc --citeproc).After merge (maintainer, on the review thread)
@editorialbot generate pdf.🤖 Generated with Claude Code