Skip to content

Commit 6e389c0

Browse files
committed
Update Readme to point to docs
1 parent 383a8a7 commit 6e389c0

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ realize a logical quantum operation, or state preparation that aims to drive the
99

1010
Quandary targets deployment on High-Performance Computing platforms, offering various levels for parallelization using the message passing paradigm. Quandary is written in C++ and executed by providing a text-based configuration file. Further, a Python interface is available to call the underlying C++ code from within a python interpreter, to ease usage.
1111

12-
It is advised to look at the user guide in `doc/`, describing the underlying mathematical models, their implementation and usage in Quandary.
13-
1412
Feel free to reach out to Stefanie Guenther [guenther5@llnl.gov] for any question you may have.
1513

14+
# Documentation
15+
Both user and code documentation is available [here](https://software.llnl.gov/quandary).
16+
1617
# Building
1718
Quandary uses CMake and [BLT](https://github.com/LLNL/blt) to handle builds. Since BLT is included as a
1819
submodule, first make sure you run:
@@ -152,8 +153,6 @@ See `tests/performance/README.md` for more information.
152153

153154
Quandary is an open source project that is under heavy development. Contributions in all forms are very welcome, and can be anything from new features to bugfixes, documentation, or even discussions. Contributing is easy, work on your branch, create a pull request to `main` when you're good to go and the regression tests pass.
154155

155-
Developer documentation is made with [Doxygen](https://www.doxygen.org) and is viewable [here](https://software.llnl.gov/quandary/doxygen).
156-
157156
# Publications
158157
* S. Guenther, N.A. Petersson, J.L. DuBois: "Quantum Optimal Control for Pure-State Preparation Using One Initial State", AVS Quantum Science, vol. 3, arXiv preprint <https://arxiv.org/abs/2106.09148> (2021)
159158
* S. Guenther, N.A. Petersson, J.L. DuBois: "Quandary: An open-source C++ package for High-Performance Optimal Control of Open Quantum Systems", submitted to IEEE Supercomputing 2021, arXiv preprint <https://arxiv.org/abs/2110.10310> (2021)

0 commit comments

Comments
 (0)