Skip to content

Commit

Permalink
update readme and vbe tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
liwt31 committed Nov 14, 2024
1 parent 7aa0efe commit 545a7eb
Show file tree
Hide file tree
Showing 4 changed files with 198 additions and 196 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![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)
[![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)

English | [简体中文](https://github.com/tensorcircuit/TenCirChem-ng/blob/master/README_CN.md)
Expand All @@ -23,6 +23,10 @@ Getting started with TenCirChem-NG by installing the package via pip:
pip install tencirchem-ng
```

Some functionality of TenCirChem-NG requires JAX.
Please install JAX following [installation instructions](https://jax.readthedocs.io/en/latest/installation.html)
or simply by ``pip install tencirchem-ng[jax]``.

## Simple to Use
TenCirChem is written in pure Python, and its use is straightforward. Here's an example of calculating UCCSD:

Expand Down
5 changes: 4 additions & 1 deletion README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![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)
[![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)

[English](https://github.com/tensorcircuit/TenCirChem-NG/) | 简体中文
Expand All @@ -21,6 +21,9 @@ TenCirChem-NG与TenCirChem完全兼容,并具有更多特性和漏洞修复。
pip install tencirchem
```

TenCirChem的一些功能依赖JAX,请参见[安装指南](https://jax.readthedocs.io/en/latest/installation.html)安装JAX,
或直接通过``pip install tencirchem-ng[jax]``安装。

## 简单易用
TenCirChem 用纯 Python 编写,使用起来非常简单。以下是计算 UCCSD 的示例:

Expand Down
Loading

0 comments on commit 545a7eb

Please sign in to comment.