diff --git a/README.md b/README.md index e9875cd3b..dc102ba52 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Faster simulations of fermionic quantum circuits. ## What is ffsim? + + ffsim is a software library for simulating fermionic quantum circuits that conserve particle number and the Z component of spin. This category includes many quantum circuits used for quantum chemistry simulations. By exploiting the symmetries and using specialized algorithms, ffsim can simulate these circuits much faster @@ -11,6 +13,8 @@ than a generic quantum circuit simulator. **Experimental disclaimer**: ffsim is currently an experimental release. Breaking changes may be introduced without warning. + + ## Documentation Documentation is located at the [project website](https://qiskit-community.github.io/ffsim/). @@ -23,12 +27,16 @@ ffsim is supported on Linux, macOS, and the Windows Subsystem for Linux (WSL). I ### From PyPI + + ffsim is available on [PyPI](https://pypi.org/project/ffsim/). It can be installed by running the command ```bash pip install ffsim ``` + + ### From source Installing ffsim from source requires the following system dependencies: diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 000000000..73e4d92bb --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,11 @@ +# API Reference + +```{toctree} + +ffsim +ffsim.contract +ffsim.linalg +ffsim.optimize +ffsim.random +ffsim.testing +``` diff --git a/docs/api/index.rst b/docs/api/index.rst deleted file mode 100644 index 77aa016af..000000000 --- a/docs/api/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -API Reference -============= - -.. toctree:: - :maxdepth: 2 - - ffsim - ffsim.contract - ffsim.linalg - ffsim.optimize - ffsim.random - ffsim.testing diff --git a/docs/conf.py b/docs/conf.py index 7bc18155d..8d8ba4613 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,6 +25,7 @@ "sphinx.ext.viewcode", "sphinx.ext.extlinks", "sphinx_autodoc_typehints", + "myst_parser", "nbsphinx", ] @@ -49,4 +50,5 @@ # nbsphinx options (for tutorials) nbsphinx_timeout = 500 -nbsphinx_execute = "always" +# TODO change this back to "always" +nbsphinx_execute = "never" diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..bdb270527 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,28 @@ +# ffsim + +Faster simulations of fermionic quantum circuits. + +## What is ffsim? + +```{include} ../README.md +:start-after: +:end-before: +``` + +## Install from PyPI + +```{include} ../README.md +:start-after: +:end-before: +``` + +## Get started + +Check out the [tutorials](tutorials/index.md). + +```{toctree} +:hidden: + +tutorials/index +api/index +``` diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index ebf741717..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -================================= -Welcome to ffsim's documentation! -================================= - -ffsim is a software library for simulating fermionic quantum circuits that conserve particle number -and the Z component of spin. This category includes many quantum circuits used for quantum chemistry simulations. -By exploiting the symmetries and using specialized algorithms, ffsim can simulate these circuits much faster -than a generic quantum circuit simulator. - -.. toctree:: - :maxdepth: 1 - - tutorials/index - api/index diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md new file mode 100644 index 000000000..f22ff11cc --- /dev/null +++ b/docs/tutorials/index.md @@ -0,0 +1,11 @@ +# Tutorials + +```{toctree} + +01-introduction +02-orbital-rotation +03-double-factorized +04-lucj +05-entanglement-forging +06-fermion-operator +``` diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst deleted file mode 100644 index f7f30b035..000000000 --- a/docs/tutorials/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -Tutorials -========= - -.. toctree:: - :maxdepth: 1 - - 01-introduction - 02-orbital-rotation - 03-double-factorized - 04-lucj - 05-entanglement-forging - 06-fermion-operator \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 75599937b..8775f559c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,6 +28,7 @@ dev = [ "jupyter-sphinx", "maturin", "mypy", + "myst-parser", "nbmake", "nbsphinx", "pytest",