Repository navigation
Docs: DocC articles for Bragg, Parallax, Strain, Embedding, Ptycho - #4
Merged
Merged
Conversation
…; Essentials topics on the landing pages Landing pages gain an Essentials group linking the new article; CuboStrain gets a Topics section and CuboEmbedding the core types. Snippets are not compiled here (no Swift toolchain in the cloud); the Mac nightly compiles them. Done: one article per module without one. Next: Mac nightly compiles the snippets and runs tools/build-docs.sh. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017m2gX21vg1oPg1CC7KqQRb
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.
Requested by Paul · project thread
Every module now has a landing page with Topics and at least one article. Core, Phase and Virtual already had both; this adds the five missing articles and links them from the landing pages.
All five snippets are unverified. The cloud has no Swift toolchain, so none was compiled or run. The Mac nightly compiles them. I wrote each against the public sources by reading signatures, so a compile error is possible. The printed values and the KMeans labels in the comments are expectations, not observed output.
Finding-Bragg-disks(CuboBragg)MappedCube(npy:),VirtualDiffraction.mean(of:),ProbeKernel.flat,BraggDisks.detect(_:kernel:options:),BraggDisks.detectAll(in:kernel:options:tiling:),BraggVectorssubscriptAligning-images(CuboParallax)ParallaxAlignment.shifted(_:rows:columns:by:),ParallaxShift(row:column:),ParallaxAlignment.shift(reference:moving:rows:columns:upsampleFactor:)From-peaks-to-strain(CuboStrain)LatticeBasis,LatticeVector,LatticeStrain.strain(local:reference:coordinateRotation:),StrainTensorClustering-patterns(CuboEmbedding)PCA.fit(_:rows:columns:components:variant:),PCAResult.scores,KMeans.fit(_:rows:columns:initialCentroids:...),KMeansResult.labelsPreparing-a-reconstruction(CuboPtycho)PtychographyPreparation.objectSampling(wavelength:angularSampling:size:),PtychographyProbe.build(...),PtychographyArray.rows/columnsLanding pages: an Essentials group is added to Bragg, Parallax, Embedding and Ptycho. CuboStrain had no Topics, so it gets a full list. CuboBragg also lists
BraggScanResult,BraggFailurePolicy,BraggMaskingandBraggTieOrder. CuboEmbedding listsPCA,PCAResult,KMeans,KMeansResultandEmbeddingError.Mac to do:
tools/readme-consumer/run.shdoes not cover these articles, which are not the README. Compile the snippets by hand, then runtools/build-docs.shand look for unresolved topics or warnings.No Swift source or number changes, so no CHANGELOG entry.
Generated by Claude Code