photonoxide 0.3.3

Validated, fabrication-ready photonics for Rust: mode solvers, FDFD, FDTD, inverse design, layout and PDKs, with a live studio
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

//! Every validation case passes, and docs/validation.md is exactly the report the code writes.
//! Slow in a debug build: CI runs it in release (`cargo test --release --test validation_report
//! -- --ignored`). After a change, rewrite the report with `photonoxide validate --write
//! docs/validation.md`.

#[test]
#[ignore = "runs every validation case: slow, run in release by the Validation report job"]
fn the_validation_report_passes_and_is_up_to_date() {
    let (report, passed) = photonoxide::validation::report();
    assert!(passed, "some validation cases failed:\n{report}");
    let path = concat!(env!("CARGO_MANIFEST_DIR"), "/docs/validation.md");
    let current = std::fs::read_to_string(path)
        .unwrap_or_default()
        .replace("\r\n", "\n");
    assert!(
        current == report,
        "docs/validation.md is out of date: run `photonoxide validate --write docs/validation.md`"
    );
}