Skip to content

[DOCS] Update links for operator definitions #1627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 12, 2025
Merged

[DOCS] Update links for operator definitions #1627

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/lib/SiteTypes/src/sitetype.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are currently a few built-in site types
recognized by `jl`. The system is easily extensible
by users. To add new operators to an existing site type,
or to create new site types, you can follow the instructions
[here](https://itensor.github.io/jl/stable/examples/Physics.html).
[here](https://itensor.github.io/ITensors.jl/stable/examples/Physics.html).

The current built-in site types are:

Expand Down Expand Up @@ -106,8 +106,8 @@ Many operators are available, for example:
`"Cdagup"`, `"Cdn"`, `"Cdagdn"`, `"Sz"`, `"Sx"`, `"Sy"`, `"S+"`, `"S-"`, ...
- ...

You can view the source code for the internal SiteType definitions
and operators that are defined [here](https://github.com/ITensor/jl/tree/main/src/physics/site_types).
You can view the internal SiteType definitions and operators
[here](https://itensor.github.io/ITensors.jl/stable/IncludedSiteTypes.html).
"""
SiteType(s::AbstractString) = SiteType{SmallString(s)}()

Expand Down Expand Up @@ -228,9 +228,9 @@ s = Index(2, "Site,S=1/2")
Sz = op("Sz", s)
```

To see all of the operator names defined for the site types included with
ITensor, please view the [source code](https://github.com/ITensor/jl/tree/main/src/physics/site_types)
for each site type. Note that some site types such as "S=1/2" and "Qubit"
You can see all of the operator names defined for the site types included
with ITensor [here](https://itensor.github.io/ITensors.jl/dev/IncludedSiteTypes.html).
Note that some site types such as "S=1/2" and "Qubit"
are aliases for each other and share operator definitions.
"""
function op(name::AbstractString, s::Index...; adjoint::Bool=false, kwargs...)
Expand Down
Loading