Skip to content

Commit

Permalink
[DOCS] Warning in ITensors.compile() docs about ITensors v0.7 (#1606)
Browse files Browse the repository at this point in the history 
* [DOCS] Warning in `ITensors.compile()` docs about ITensors v0.7

* [ITensors] Bump to v0.7.9
  • Loading branch information
@mtfishman
mtfishman authored Dec 13, 2024
1 parent f55dbc4 commit e5eee23
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
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.8"
version = "0.7.9"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
6 changes: 6 additions & 0 deletions src/packagecompile/compile.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,11 @@ This will take some time, perhaps a few minutes.
This will create a system image containing the compiled version of ITensors
located at `dir/filename`, by default `$(default_compile_path())`.
!!! 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.
$(compile_note())
""" compile

2 comments on commit e5eee23

@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/121341

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.9 -m "<description of version>" e5eee2386a7f19f4004e171fa341eee63cee50dc
git push origin v0.7.9

Please sign in to comment.