Skip to content

Add ecosystem overview diagram #2

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
mtfishman merged 2 commits into from
Mar 21, 2025
Merged

Add ecosystem overview diagram #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c828fb6
Add ecosystem overview diagram
mtfishman Mar 21, 2025
990ddae
Load DocumenterMermaid during docs build
mtfishman Mar 21, 2025
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
2 changes: 2 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
ITensorDocsNext = "701fd796-f527-45da-9a53-2681c1a90c45"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c"

[compat]
Documenter = "1.9.0"
DocumenterMermaid = "0.2.0"
ITensorDocsNext = "0.1.0"
Literate = "2.20.1"
MultiDocumenter = "0.7.1"
3 changes: 2 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
# `--temp`, in which case the source repositories are cloned into a temporary
# directory (as opposed to `docs/clones`).
using Documenter: Documenter
using DocumenterMermaid: DocumenterMermaid
using ITensorDocsNext: ITensorDocsNext
using MultiDocumenter: MultiDocumenter

Expand All @@ -23,7 +24,7 @@ Documenter.makedocs(;
sitename="ITensor ecosystem docs",
modules=[ITensorDocsNext],
warnonly=true,
pages=["index.md"],
pages=["index.md", "ecosystem_overview.md"],
)

@info "Building aggregate ITensorDocsNext site"
Expand Down
18 changes: 18 additions & 0 deletions docs/src/ecosystem_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ITensor ecosystem overview

```mermaid
graph TD
ITensors(ITensors.jl) --> ITensorBase(ITensorBase.jl)
ITensorBase --> NamedDimsArrays(NamedDimsArrays.jl)
NamedDimsArrays --> SparseArraysBase(SparseArraysBase.jl)
NamedDimsArrays --> DiagonalArrays(DiagonalArrays.jl)
NamedDimsArrays --> BlockSparseArrays(BlockSparseArrays.jl)
NamedDimsArrays --> FusionTensors(FusionTensors.jl)
BlockSparseArrays --> SparseArraysBase
BlockSparseArrays --> DiagonalArrays
BlockSparseArrays --> GradedUnitRanges(GradedUnitRanges.jl)
DiagonalArrays --> SparseArraysBase
FusionTensors --> BlockSparseArrays
FusionTensors --> GradedUnitRanges
GradedUnitRanges --> SymmetrySectors(SymmetrySectors.jl)
```
Loading