updte

LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Qi Yang <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,22 +1,21 @@
-# Gaussian-fPEPS
+# gaussian-fpeps
 
-Translate the projected BCS state to the fermionic projected entangled pair state(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)
 
-# About
+-----
 
-Demo code for the paper [Projected d-wave superconducting state: a fermionic projected entangled pair state study](https://arxiv.org/abs/2208.04566).
+**Table of Contents**
 
+- [Installation](#installation)
+- [License](#license)
 
-# Example
+## Installation
 
-Using [Pluto](https://github.com/fonsp/Pluto.jl) Notebook and open example.jl
+```console
+pip install gaussian-fpeps
+```
 
-# Install
+## 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:
-
-[Pluto](https://github.com/fonsp/Pluto.jl) is needed to open the example notebook.
+`gaussian-fpeps` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "gaussian-fpeps"
+dynamic = ["version"]
+description = ''
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Qi Yang", email = "[email protected]" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = []
+
+[project.urls]
+Documentation = "https://github.com/unknown/gaussian-fpeps#readme"
+Issues = "https://github.com/unknown/gaussian-fpeps/issues"
+Source = "https://github.com/unknown/gaussian-fpeps"
+
+[tool.hatch.version]
+path = "src/gaussian_fpeps/__about__.py"
+
+[tool.hatch.envs.default]
+dependencies = [
+  "coverage[toml]>=6.5",
+  "pytest",
+]
+[tool.hatch.envs.default.scripts]
+test = "pytest {args:tests}"
+test-cov = "coverage run -m pytest {args:tests}"
+cov-report = [
+  "- coverage combine",
+  "coverage report",
+]
+cov = [
+  "test-cov",
+  "cov-report",
+]
+
+[[tool.hatch.envs.all.matrix]]
+python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+[tool.hatch.envs.types]
+dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/gaussian_fpeps tests}"
+
+[tool.coverage.run]
+source_pkgs = ["gaussian_fpeps", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/gaussian_fpeps/__about__.py",
+]
+
+[tool.coverage.paths]
+gaussian_fpeps = ["src/gaussian_fpeps", "*/gaussian-fpeps/src/gaussian_fpeps"]
+tests = ["tests", "*/gaussian-fpeps/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

src/gaussian_fpeps/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2024-present Qi Yang <[email protected]>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.1"

src/gaussian_fpeps/__init__.py

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2024-present Qi Yang <[email protected]>
+#
+# SPDX-License-Identifier: MIT
+
+from main import gaussian_fpeps

tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Qi Yang <[email protected]>
+#
+# SPDX-License-Identifier: MIT