Skip to content

Commit c1a4a83

Browse files
refraction-rayrefraction-ray
committed
v0.0.220311
1 parent 17cf163 commit c1a4a83

15 files changed

+6417
-489
lines changed

‎CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Unreleased
44

5+
## 0.0.220311
6+
57
### Added
68

79
- add sigmoid method on backends

‎HISTORY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
TensorCircuit is initially a personal project by @refraction-ray (Shi-Xin Zhang). He began this project in April 2020, inspired by the MPS quantum simulator [mpsim](https://github.com/grmlarose/mpsim) and the introduction of Google [TensorNetwork](https://github.com/google/TensorNetwork) package. This project is further developed by him during 2020 and the first half of 2021 when he was a PhD candidate at Tsinghua University, with multiple new features and applications added for his research purpose. The original TensorCircuit project is archived now on [GitHub](https://github.com/refraction-ray/tensorcircuit/). He decided to make this project an official open-source product after he joined Tencent in July 2021. And he has extensively refactored and optimized the codebase since then. As the project owner and the main author, he thanks all the contributors who have made TensorCircuit and the ecosystem better.
1+
TensorCircuit is initially a personal project by @refraction-ray (Shi-Xin Zhang). He began this project in April 2020, inspired by the MPS quantum simulator [mpsim](https://github.com/grmlarose/mpsim) and the introduction of Google [TensorNetwork](https://github.com/google/TensorNetwork) package. This project is further developed by him during 2020 and the first half of 2021 when he was a PhD candidate at Tsinghua University, with multiple new features and applications added for his research purpose. The original TensorCircuit project is archived now on [GitHub](https://github.com/refraction-ray/tensorcircuit/). He decided to make this project an official open-source product after he joined Tencent in July 2021. And he has extensively refactored and optimized the codebase since then. As the the lead author for this project, he thanks all the contributors who have made TensorCircuit and the ecosystem better.

‎MANIFEST.in

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
include README.md
2-
include doc/*
2+
include README_cn.md
3+
include HISTORY.md
34
include LICENSE
5+
include CHANGELOG.md
6+
include docs/*
47
include examples/*
58
include tests/*

‎README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,12 @@ print(g(theta))
7272

7373
For contribution guidelines and notes, see [CONTRIBUTING](/CONTRIBUTING.md).
7474

75-
### Cautions
76-
77-
Please open issues or PRs.
78-
79-
Keep the codebase private!
8075

8176
### Install
8277

83-
For development workflow, we suggest to first configure a good conda environment. The versions of dependecy package may vary in terms of development requirements. The minimum requirement is the [TensorNetwork](https://github.com/google/TensorNetwork) package (pip install suggested).
78+
For users, ``pip install tensorcircuit`` is enough. (Extra package installation may be required for some features.)
79+
80+
For developers, we suggest to first configure a good conda environment. The versions of dependence packages may vary in terms of development requirements. The minimum requirement is the [TensorNetwork](https://github.com/google/TensorNetwork) package. [Dockerfiles](/docker) may also be helpful for building a good development enviroment.
8481

8582
## Researches and applications
8683

‎docs/source/api/templates.rst

+2
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@ tensorcircuit.templates
22
==================================================
33
.. toctree::
44
templates/blocks.rst
5+
templates/chems.rst
6+
templates/dataset.rst
57
templates/graphs.rst
68
templates/measurements.rst

‎docs/source/api/templates/chems.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
tensorcircuit.templates.chems
2+
==================================================
3+
.. automodule:: tensorcircuit.templates.chems
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:

‎docs/source/api/templates/dataset.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
tensorcircuit.templates.dataset
2+
==================================================
3+
.. automodule:: tensorcircuit.templates.dataset
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:

‎docs/source/api/translation.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
tensorcircuit.translation
2+
==================================================
3+
.. automodule:: tensorcircuit.translation
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:

‎docs/source/contribution.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ We utilize a python script to generate/refresh all API docs rst files under /doc
154154

155155
.. code-block:: bash
156156
157-
cd docs
157+
cd docs/source
158158
python generate_rst.py
159159
160160
**i18n:**

‎docs/source/locale/cn/LC_MESSAGES/api.po

+5,927-47
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)