Skip to content

Commit eef1562

Browse files
update docs
1 parent 2bdd0d0 commit eef1562

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

docs/source/advance.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,8 @@ Stabilizer Circuit Simulator
358358
TensorCircuit-NG provides a Stabilizer Circuit simulator for efficient simulation of Clifford circuits.
359359
This simulator is particularly useful for quantum error correction, measurement induced phase transition, etc.
360360

361+
The stabilizer simulation is backend by Python package `Stim <https://github.com/quantumlib/Stim>`_, please ensure you have ``pip install stim`` first.
362+
361363

362364
.. code-block:: python
363365
@@ -389,7 +391,7 @@ The simulator supports common Clifford gates and operations:
389391
- Entanglement calculation (``c.entanglement_entropy``)
390392
- Pauli string operator expectation (``c.expectation_ps``)
391393
- Openqasm and qir transformation as usual circuits
392-
- Initialization state provided by Pauli string stabilizer (``tc.StabCircuit(inputs=...)``) or inverse tableau (`tc.StabCircuit(tableau_inputs=)`)
394+
- Initialization state provided by Pauli string stabilizer (``tc.StabCircuit(inputs=...)``) or inverse tableau (``tc.StabCircuit(tableau_inputs=)``)
393395
- Probabilistic noise (``c.depolarizing``)
394396

395397

docs/source/index.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ TensorCircuit Next Generation
1111
Introduction
1212
---------------
1313

14-
TensorCircuit-NG is an open-source high-performance quantum software framework in Python.
14+
`TensorCircuit-NG <https://github.com/tensorcircuit/tensorcircuit-ng>`_ is an open-source high-performance quantum software framework in Python.
1515

1616
* It is built for humans. 👽
1717

@@ -32,13 +32,19 @@ With the help of TensorCircuit-NG, now get ready to efficiently and elegantly so
3232
.. important::
3333
Please cite the `whitepaper <https://quantum-journal.org/papers/q-2023-02-02-912/>`_ when using TensorCircuit or TensorCircuit-NG in your research. The bibtex information is provided by ``tc.cite()``.
3434

35+
.. note::
36+
The TensorCircuit package is outdated.
37+
We recommend upgrading to TensorCircuit-NG for the latest features and improvements.
38+
You can upgrade by running the following command:
39+
``pip uninstall tensorcircuit && pip install tensorcircuit-ng``
3540

3641

3742
Useful Links
3843
--------------------
3944

4045

41-
TensorCircuit is created and now maintained as TensorCircuit-NG by `Shi-Xin Zhang <https://github.com/refraction-ray>`_.
46+
TensorCircuit is created and now maintained as
47+
`TensorCircuit-NG <https://github.com/tensorcircuit/tensorcircuit-ng>`_ by `Shi-Xin Zhang <https://github.com/refraction-ray>`_.
4248

4349
The current core authors of TensorCircuit-NG are `Shi-Xin Zhang <https://github.com/refraction-ray>`_ and `Yu-Qin Chen <https://github.com/yutuer21>`_.
4450
We also thank `contributions <https://github.com/tensorcircuit/tensorcircuit-ng/graphs/contributors>`_ from the open source community.
@@ -54,6 +60,13 @@ If you have any further questions or collaboration ideas, please use the issue t
5460

5561
GitHub
5662

63+
64+
.. card:: PyPI
65+
:link: https://pypi.org/project/tensorcircuit-ng
66+
:shadow: md
67+
68+
``pip install tensorcircuit-ng``
69+
5770

5871
.. card:: Documentation
5972
:link: https://tensorcircuit-ng.readthedocs.io
@@ -83,12 +96,6 @@ If you have any further questions or collaboration ideas, please use the issue t
8396
GitHub Discussions
8497

8598

86-
.. card:: PyPI
87-
:link: https://pypi.org/project/tensorcircuit-ng
88-
:shadow: md
89-
90-
``pip install``
91-
9299

93100
.. card:: DockerHub
94101
:link: https://hub.docker.com/repository/docker/tensorcircuit/tensorcircuit
@@ -107,8 +114,6 @@ If you have any further questions or collaboration ideas, please use the issue t
107114

108115

109116

110-
111-
112117
Unified Quantum Programming
113118
------------------------------
114119

@@ -159,7 +164,7 @@ TensorCircuit-NG is unifying infrastructures and interfaces for quantum computin
159164
:columns: 12 6 3 3
160165
:shadow: md
161166

162-
ideal/noisy/approximate/analog simulation
167+
ideal/noisy/approx/analog/stabilizer
163168

164169
.. grid-item-card:: Unified Representations
165170
:columns: 12 6 3 3

0 commit comments

Comments
 (0)