Skip to content

Update user guide and documentation for v1.1.0#713

Open
manuschneider wants to merge 186 commits intohaoti/doc_updatefrom
manuel/doc_update
Open

Update user guide and documentation for v1.1.0#713
manuschneider wants to merge 186 commits intohaoti/doc_updatefrom
manuel/doc_update

Conversation

@manuschneider
Copy link
Copy Markdown
Collaborator

Still in progress, see #712
I would be happy about help with #596

-removed unnecessary includes
-cleared up code
…rs are not the same (same behavior as Block(Fermionic)UniTensor);

more information for debugging when unitttests fail
added default value to Tensor.Inv
changed unittests to really test the clipping
updated documentation
-small fixes for consistency and improvements of the code
-made tensor names consistent with python version
…ipping

-added unit tests
-improved test tools on GPU
-minor fixes
-removed namespace std usage
-removed maxiteration value from TDVP, since it did not fix the issue on github
manuschneider and others added 19 commits April 4, 2026 00:13
… any argument to avoid overhead of argument check; did not do this for put_block(_) for code readability
…ifier

- Fix copy-paste bug: put_block_ error message incorrectly said "Use
  get_block_(0)" instead of "Use put_block_(0)"
- Replace %d with %llu (and cast to unsigned long long) for cytnx_uint64
  in all four new error messages (get_block, get_block_ x2, put_block,
  put_block_) to avoid undefined behavior
- Apply the same two-overload pattern used by get_block/get_block_ to
  put_block/put_block_: no-arg fast path + idx-with-check overload that
  delegates to it, making the API consistent

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- tests/BlockUniTensor_test.cpp: fix loop bounds j<5 → j<11 for BUT4
  second bond dim (Add, Mul, Sub, Div, Conj, Trace, Dagger, elem_exist)
- tests/gpu/BlockUniTensor_test.cpp: fix gpu_Trace 0-indexed loop body
  using {j-1,k-1} → {j,k}
- tests/BlockFermionicUniTensor_test.cpp: add Transpose test covering
  rowrank update, bond redirection, element preservation, and involution
- tests/DenseUniTensor_test.cpp: remove dead bond redirect loop in
  Transpose_tagged (modified local copies, had no effect)
- include/UniTensor.hpp: fix typo "onces" → "ones" in Transpose docstring
- example/DMRG, example/TDVP: add comments explaining Dagger().permute_()
  pattern needed after PR #725 index-order change

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- linalg test files: keep master's Check_UU_VV_Identity helper (no use)
- BlockUniTensor_test.cpp: keep 0-indexed {i,j,k,l} from our branch
- DMRG examples: keep relabels_() and set_name() calls from our branch

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace retired macos-13 runner with macos-15-intel
Bumps [requests](https://github.com/psf/requests) from 2.32.3 to 2.33.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](psf/requests@v2.32.3...v2.33.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-version: 2.33.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
…33.0

Bump requests from 2.32.3 to 2.33.0 in /docs
Bumps [setuptools](https://github.com/pypa/setuptools) from 75.8.2 to 78.1.1.
- [Release notes](https://github.com/pypa/setuptools/releases)
- [Changelog](https://github.com/pypa/setuptools/blob/main/NEWS.rst)
- [Commits](pypa/setuptools@v75.8.2...v78.1.1)

---
updated-dependencies:
- dependency-name: setuptools
  dependency-version: 78.1.1
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [pygments](https://github.com/pygments/pygments) from 2.19.1 to 2.20.0.
- [Release notes](https://github.com/pygments/pygments/releases)
- [Changelog](https://github.com/pygments/pygments/blob/master/CHANGES)
- [Commits](pygments/pygments@2.19.1...2.20.0)

---
updated-dependencies:
- dependency-name: pygments
  dependency-version: 2.20.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.3.0 to 2.6.3.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](urllib3/urllib3@2.3.0...2.6.3)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-version: 2.6.3
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
…78.1.1

Bump setuptools from 75.8.2 to 78.1.1 in /docs
…20.0

Bump pygments from 2.19.1 to 2.20.0 in /docs
Transpose inverts the order of the indices
@manuschneider manuschneider changed the base branch from master to haoti/doc_update April 10, 2026 17:26
@manuschneider manuschneider marked this pull request as ready for review April 10, 2026 17:58
@manuschneider manuschneider added the Pending check/approval Issue fixed, and need feedback label Apr 10, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: da8be6dc83

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +24 to +25
git fetch origin ${{ github.event.pull_request.base.ref }}
git merge --no-edit origin/${{ github.event.pull_request.base.ref }}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Configure git identity before merging in CI jobs

This step runs git merge --no-edit, and git merge performs a commit by default (--[no-]commit perform a commit if the merge succeeds), so on runners without a preconfigured user.name/user.email it aborts with “Committer identity unknown” whenever the merge is non-fast-forward. That causes pull_request workflows to fail before tests even start; add an explicit git config user.name/user.email (or avoid creating a merge commit) before this command.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is taken over from the current master branch, which was merged into this branch. Can someone comment?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is from 808ba2d

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@IvanaGyro could you check this?

Comment thread CMakeLists.txt
Comment on lines +380 to +383
set_target_properties(pycytnx
PROPERTIES
INSTALL_RPATH "${CMAKE_INSTALL_RPATH};${CMAKE_INSTALL_PREFIX}/lib"
)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve CUDA dependency paths in pycytnx RPATH

On non-macOS installs, pycytnx now only gets ${CMAKE_INSTALL_RPATH};${CMAKE_INSTALL_PREFIX}/lib, which drops the previously included ${CUTENSOR_LIBRARY_DIRS} and ${CUQUANTUM_LIBRARY_DIRS}. In builds with USE_CUTENSOR/USE_CUQUANTUM, this can leave the installed Python extension unable to locate those shared libraries at import time unless users manually export LD_LIBRARY_PATH, so the CUDA library directories (or equivalent link-path propagation) should be retained in the install RPATH.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is taken over from the current master branch, which was merged into this branch. Can someone comment?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from f2e9345

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yingjerkao could you check this?

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ae00a31334

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +1 to +3
"""
Python-side smoke and correctness tests for UniTensor.apply() and UniTensor.apply_()
pybind bindings.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Place new apply() pytest in the CI-discovered test tree

This new test module is added under tests/, but the CI workflow runs pytest pytests/ (see .github/workflows/ci-cmake_tests.yml), so this suite is never executed in pull requests. That means regressions in the new UniTensor.apply/apply_ Python bindings can merge undetected despite having a test file present.

Useful? React with 👍 / 👎.

Comment thread CMakePresets.json
"BUILD_DOC": "OFF",
"DEV_MODE": "OFF"
"DEV_MODE": "OFF",
"CMAKE_INSTALL_PREFIX": "~/.local/cytnx"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Replace tilde install prefix with an explicit absolute path

Setting CMAKE_INSTALL_PREFIX to ~/.local/cytnx in a preset is unsafe because CMake cache values are not shell-expanded; the ~ is treated literally. Users invoking this preset can end up installing into an unexpected literal/relative path instead of their home directory, so this should use an explicit path (for example $env{HOME}/.local/cytnx).

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yingjerkao could you check this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Pending check/approval Issue fixed, and need feedback

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants