Update README.md

README.md

@@ -1,21 +1,29 @@
-# gaussian-fpeps
+# Gaussian-fPEPS
 
-[![PyPI - Version](https://img.shields.io/pypi/v/gaussian-fpeps.svg)](https://pypi.org/project/gaussian-fpeps)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/gaussian-fpeps.svg)](https://pypi.org/project/gaussian-fpeps)
+Translate the projected BCS state to the fermionic projected entangled pair state(fPEPS).
 
------
+# About
 
-**Table of Contents**
+Demo code for the paper [Projected d-wave superconducting state: a fermionic projected entangled pair state study](https://arxiv.org/abs/2208.04566).
 
-- [Installation](#installation)
-- [License](#license)
 
-## Installation
+# Example
 
-```console
-pip install gaussian-fpeps
+- Using [Pluto](https://github.com/fonsp/Pluto.jl) Notebook and open example.jl
+- An alternative implementation of "translation" is `translate.py`
+
+# Install
+
+Dependencies are maintained via `hatch`. Run codes with
+```
+  hatch run python gfpeps_app.py
+  hatch run python translate.py
 ```
 
-## License
+## Python dependencies:
+
+[JAX](https://github.com/google/jax), [PyManopt](https://pymanopt.org/) and [h5py](https://docs.h5py.org/en/stable/) are required to run gfpeps/main.py.
+
+## Julia dependencies:
 
-`gaussian-fpeps` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+[Pluto](https://github.com/fonsp/Pluto.jl) is needed to open the example notebook to open example.jl.