Skip to content

Add Benchmark Comparison #314

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

Closed
wants to merge 2 commits into from
Closed

Add Benchmark Comparison #314

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
506be64
Add Benchmark Comparison
albertomercurio Nov 19, 2024
c430b28
Fix missing url
albertomercurio Nov 19, 2024
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: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*.jl.*.cov
*.jl.cov
*.jl.mem
Manifest.toml
/Manifest.toml
Copy link
Member

@ytdHuang ytdHuang Nov 19, 2024

Choose a reason for hiding this comment

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

I think this need to be rebased.

Copy link
Member Author

@albertomercurio albertomercurio Nov 19, 2024

Choose a reason for hiding this comment

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

No, I need it to keep the Manifest of the benchmark comparison, otherwise it removes every Manifest file. I need the Manifest because I want reproducibility, like also the requirements.txt for the python packages.


.vscode

Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,12 @@ e_ops = [a_gpu' * a_gpu]
sol = mesolve(H_gpu, ψ0_gpu, tlist, c_ops, e_ops = e_ops)
```

## Performance comparison with other packages

Here we provide a brief performance comparison between `QuantumToolbox.jl` and other popular quantum physics simulation packages, such as [`QuTiP`](https://github.com/qutip/qutip) (Python), [`dynamiqs`](https://github.com/dynamiqs/dynamiqs) (Python - JAX) and [`QuantumOptics.jl`](https://github.com/qojulia/QuantumOptics.jl) (Julia). We clearly show that `QuantumToolbox.jl` is the fastest package among the four. A detailed code is available [here](https://qutip.org/QuantumToolbox.jl/stable/resources/package_comparison).

![](docs/src/resources/package_comparison.png)

## Contributing to QuantumToolbox.jl

You are most welcome to contribute to `QuantumToolbox.jl` development by forking this repository and sending pull requests (PRs), or filing bug reports at the issues page. You can also help out with users' questions, or discuss proposed changes in the [QuTiP discussion group](https://groups.google.com/g/qutip).
Expand Down
1 change: 1 addition & 0 deletions benchmarks/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/Manifest.toml
Copy link
Member

@ytdHuang ytdHuang Nov 19, 2024

Choose a reason for hiding this comment

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

I think we don't need this file

Copy link
Member Author

@albertomercurio albertomercurio Nov 19, 2024

Choose a reason for hiding this comment

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

Same as above

3 changes: 3 additions & 0 deletions benchmarks/package_comparison/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export JULIA_NUM_THREADS=16
export JULIA_CONDAPKG_BACKEND=Null
export JULIA_PYTHONCALL_EXE=$(which python)
1 change: 1 addition & 0 deletions benchmarks/package_comparison/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pyenv/
Loading
Loading