Skip to content

Commit

Permalink
[DOCS] More clarifications for ITensors.compile() (#1607)
Browse files Browse the repository at this point in the history 
* [DOCS] More clarifications for `ITensors.compile()`

* [ITensors] Bump to v0.7.10
  • Loading branch information
@mtfishman
mtfishman authored Dec 13, 2024
1 parent e5eee23 commit 88f7d3e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ITensors"
uuid = "9136182c-28ba-11e9-034c-db9fb085ebd5"
authors = ["Matthew Fishman <[email protected]>", "Miles Stoudenmire <[email protected]>"]
version = "0.7.9"
version = "0.7.10"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
11 changes: 10 additions & 1 deletion docs/src/AdvancedUsageGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -816,8 +816,17 @@ julia> @time svd(A, i');
ITensors provides the command `ITensors.compile()` to create what is
called a "custom system image", a custom version of Julia that
includes a compiled version of ITensors (see the [PackageCompiler documentation](https://julialang.github.io/PackageCompiler.jl/dev/) for more details).
Just run the command:
!!! compat "ITensors 0.7"
As of ITensors 0.7, you must now install and load the
[ITensorMPS.jl](https://github.com/ITensor/ITensorMPS.jl) package
in order to use `ITensors.compile()`, since it relies on running MPS/MPO
functionality as example code for Julia to compile.
Just run the commands:
```
julia> using ITensors, ITensorMPS

julia> ITensors.compile()
[...]
```
Expand Down

2 comments on commit 88f7d3e

@mtfishman
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/121358

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.7.10 -m "<description of version>" 88f7d3ec84e0cb16c919914b905f863b0dfc23a9
git push origin v0.7.10

Please sign in to comment.