Simplify the README example to plain ITensor operations#187
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #187 +/- ##
=======================================
Coverage 72.22% 72.22%
=======================================
Files 28 28
Lines 1480 1480
=======================================
Hits 1069 1069
Misses 411 411
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Rewrites the README example as a commented walkthrough of the core ITensor operations (making indices, a random tensor, indexing, contraction, addition, and a QR factorization), replacing the previous `@test` comparisons against unwrapped arrays. Dropping `unname` and the array comparisons keeps the example on the named-tensor API a new user actually writes, and the inline comments split it into per-operation blocks that render with their output on the docs Home page. Bumps the version to 0.8.3.
mtfishman
force-pushed
the
mf/readme-cleanup
branch
from
332fb8d to
67296c0
Compare
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
Rewrites the README example as a commented walkthrough of the core ITensor operations: making indices, a random tensor, indexing, contraction, addition, and a QR factorization. This replaces the previous
@testcomparisons against unwrapped arrays, so the example stays on the named-tensor API a new user actually writes. The inline comments split it into per-operation blocks that render with their output on the docs Home page.Bumps the version to 0.8.3.