Skip to content

Commit

Permalink
update readme and setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
liwt31 committed Nov 14, 2024
1 parent a76c30c commit 7aa0efe
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 23 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# TenCirChem

![TenCirChem](https://github.com/tensorcircuit/TenCirChem-ng/blob/master/docs/source/statics/logov0.png)
![TenCirChem](https://github.com/tensorcircuit/TenCirChem-NG/blob/master/docs/source/statics/logov0.png)

[![ci](https://img.shields.io/github/actions/workflow/status/tensorcircuit/TenCirChem-ng/ci.yml?branch=master)](https://github.com/tencent-quantum-lab/TenCirChem/actions)
[![codecov](https://codecov.io/github/tensorcircuit/TenCirChem-ng/branch/master/graph/badge.svg?token=6QZP1RKVTT)](https://app.codecov.io/github/tencent-quantum-lab/TenCirChem)
[![ci](https://img.shields.io/github/actions/workflow/status/tensorcircuit/TenCirChem-NG/ci.yml?branch=master)](https://github.com/tensorcircuit/TenCirChem-NG/actions)
[![codecov](https://codecov.io/github/tensorcircuit/TenCirChem-ng/branch/master/graph/badge.svg?token=6QZP1RKVTT)](https://app.codecov.io/github/tensorcircuit/TenCirChem-ng)
[![pypi](https://img.shields.io/pypi/v/tencirchem-ng.svg?logo=pypi)](https://pypi.org/project/tencirchem-ng/)
[![doc](https://img.shields.io/badge/docs-link-green.svg)](https://tensorcircuit.github.io/TenCirChem-ng/index.html)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tensorcircuit/TenCirChem-ng/master?labpath=docs%2Fsource%2Ftutorial_jupyter)
Expand Down Expand Up @@ -57,7 +57,7 @@ print(uccsd.energy(params))
print(uccsd.energy_and_grad(params))
```
For more examples and customization,
please refer to the [documentation](https://tencent-quantum-lab.github.io/TenCirChem/index.html)
please refer to the [documentation](https://tensorcircuit.github.io/TenCirChem-NG/index.html)


## Exciting Features
Expand Down Expand Up @@ -86,8 +86,8 @@ TenCirChem is designed to be:

## License
TenCirChem is released under Academic Public License.
See the [LICENSE file](https://github.com/tencent-quantum-lab/TenCirChem/blob/master/LICENSE) for details.
In short, you can use TenCirChem freely for non-commercial/academic purpose
See the [LICENSE file](https://github.com/tensorcircuit/TenCirChem-NG/blob/master/LICENSE) for details.
In short, you can use TenCirChem-NG freely for non-commercial/academic purpose
and commercial use requires a commercial license.

## Citing TenCirChem
Expand All @@ -101,6 +101,6 @@ which is also a good introduction to the software.

### Variational basis state encoder
An efficient algorithm to encode phonon states in electron-phonon systems for quantum computation.
See [examples](https://github.com/tencent-quantum-lab/TenCirChem/tree/master/example)
and the [tutorial](https://tencent-quantum-lab.github.io/TenCirChem/tutorial_jupyter/vbe_tutorial_td.html).
See [examples](https://github.com/tensorcircuit/TenCirChem-NG/tree/master/example)
and the [tutorial](https://tensorcircuit.github.io/TenCirChem-NG/tutorial_jupyter/vbe_tutorial_td.html).
Reference paper: https://arxiv.org/pdf/2301.01442.pdf (published in PRR).
20 changes: 11 additions & 9 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
# TenCirChem

![TenCirChem](https://github.com/tensorcircuit/TenCirChem-ng/blob/master/docs/source/statics/logov0.png)
![TenCirChem](https://github.com/tensorcircuit/TenCirChem-NG/blob/master/docs/source/statics/logov0.png)

[![ci](https://img.shields.io/github/actions/workflow/status/tensorcircuit/TenCirChem-ng/ci.yml?branch=master)](https://github.com/tencent-quantum-lab/TenCirChem/actions)
[![codecov](https://codecov.io/github/tensorcircuit/TenCirChem-ng/branch/master/graph/badge.svg?token=6QZP1RKVTT)](https://app.codecov.io/github/tencent-quantum-lab/TenCirChem)
[![ci](https://img.shields.io/github/actions/workflow/status/tensorcircuit/TenCirChem-NG/ci.yml?branch=master)](https://github.com/tensorcircuit/TenCirChem-NG/actions)
[![codecov](https://codecov.io/github/tensorcircuit/TenCirChem-NG/branch/master/graph/badge.svg?token=6QZP1RKVTT)](https://app.codecov.io/github/tensorcircuit/TenCirChem-NG)
[![pypi](https://img.shields.io/pypi/v/tencirchem-ng.svg?logo=pypi)](https://pypi.org/project/tencirchem-ng/)
[![doc](https://img.shields.io/badge/docs-link-green.svg)](https://tensorcircuit.github.io/TenCirChem-ng/index.html)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tensorcircuit/TenCirChem-ng/master?labpath=docs%2Fsource%2Ftutorial_jupyter)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tensorcircuit/TenCirChem-NG/master?labpath=docs%2Fsource%2Ftutorial_jupyter)

[English](https://github.com/tensorcircuit/TenCirChem-ng/) | 简体中文
[English](https://github.com/tensorcircuit/TenCirChem-NG/) | 简体中文

TenCirChem 是一个高效且通用的分子性质量子计算软件包。TenCirChem 基于[TensorCircuit],并针对化学应用进行了优化。

TenCirChem-NG与TenCirChem完全兼容,并具有更多特性和漏洞修复。

## 安装
安装 TenCirChem 非常简单。只需通过 pip 安装包即可:

Expand Down Expand Up @@ -52,7 +54,7 @@ print(uccsd.statevector(params))
print(uccsd.energy(params))
print(uccsd.energy_and_grad(params))
```
有关更多示例和自定义,请参见[文档](https://tencent-quantum-lab.github.io/TenCirChem/index.html)
有关更多示例和自定义,请参见[文档](https://tensorcircuit.github.io/TenCirChem-NG/index.html)


## 令人兴奋的功能
Expand Down Expand Up @@ -81,7 +83,7 @@ TenCirChem的设计原则是:

## 许可证
TenCirChem 使用 Academic Public License 发布。
有关详细信息,请参见[LICENSE 文件](https://github.com/tencent-quantum-lab/TenCirChem/blob/master/LICENSE)
有关详细信息,请参见[LICENSE 文件](https://github.com/tensorcircuit/TenCirChem-NG/blob/master/LICENSE)
简而言之,您可以免费使用 TenCirChem 用于非商业/学术目的,
商业用途需要获得商业许可。

Expand All @@ -96,7 +98,7 @@ TenCirChem 使用 Academic Public License 发布。

### 变分基矢编码器
变分基矢编码器是编码电声子系统中的声子用以量子计算的高效算法。
请参考[例子](https://github.com/tencent-quantum-lab/TenCirChem/tree/master/example)
[教程](https://tencent-quantum-lab.github.io/TenCirChem/tutorial_jupyter/vbe_tutorial_td.html)
请参考[例子](https://github.com/tensorcircuit/TenCirChem-NG/tree/master/example)
[教程](https://tensorcircuit.github.io/TenCirChem-NG/tutorial_jupyter/vbe_tutorial_td.html)
参考论文: https://arxiv.org/pdf/2301.01442.pdf (发表于PRR).

12 changes: 6 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@


setuptools.setup(
name="tencirchem",
version="2024.01",
author="TenCirChem Authors",
author_email="liw31@163.com",
name="tencirchem-ng",
version="2024.10",
author="TenCirChem-NG Authors",
author_email="liw31@g163.com",
description="Efficient quantum computational chemistry based on TensorCircuit",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/tencent-quantum-lab/tencirchem",
url="https://github.com/tensorcircuit/TenCirChem-NG",
packages=setuptools.find_packages(),
python_requires=">=3.7",
python_requires=">=3.9",
include_package_data=True,
install_requires=[
"numpy",
Expand Down

0 comments on commit 7aa0efe

Please sign in to comment.