Clarify one-route-per-FiberArray model and fix example inconsistencies#2
Open
d-chambers wants to merge 1 commit into
Open
Clarify one-route-per-FiberArray model and fix example inconsistencies#2d-chambers wants to merge 1 commit into
d-chambers wants to merge 1 commit into
Conversation
- Model: state that a FiberArray describes exactly one optical route whose optical_paths are non-overlapping time revisions; concurrent routes are separate FiberArrays sharing resources via References. - Spec/References: update FiberArray and OpticalPath descriptions to match. - NORFOX example: restructure from one FiberArray with five concurrent paths to five per-arm FiberArrays (ARMA-ARME) with shared interrogator resources and per-arm acquisitions. - Tunnel example: represent the two concurrent routes as two FiberArrays (PDAS, PDSS). - API/inventory: fix the fiber-break example (undefined variables, split vs split_at, mismatched source id), fill in the empty Design Rule section. - API/spool: unify patch method names with the other API pages (add_inventory_attrs, add_inventory_coords). Co-Authored-By: Claude Fable 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
1 participant
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.
Summary
Documentation/spec consistency cleanup following a design review. No model changes beyond wording — this makes the documents say what the model already intends.
FiberArraydescribes exactly one optical route, whoseoptical_pathsare non-overlapping time revisions of that route's description. Concurrent routes are separateFiberArrays that share physical resources throughReferences. The constraint list now scopes the one-valid-path rule to within aFiberArray.FiberArraywith five concurrent paths (which violated the model constraint) to five per-armFiberArrays (ARMA–ARME), each with its own acquisitions, sharing the three interrogators as resources. Added adata_source_idresolution example (NO.ARMA..FEBUS).FiberArrays (PDAS,PDSS) whose fibers share the same physical cables as shared resources.pathvariable,splitvssplit_at, unused variable, source id that didn't match the page's own inventory) and filled in the empty Design Rule section.add_inventory_attrs,add_inventory_coords).scripts/generate_references.py;quarto renderpasses.