Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jue-Xu committed Jul 3, 2024
1 parent 902ed2e commit ada55be
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Quantum Simulation Recipes
<!-- ![Figure](./figs/idea.png) -->
[![License](https://img.shields.io/github/license/qiskit-community/qiskit-algorithms.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
[![License](https://img.shields.io/github/license/Jue-Xu/Quantum-Simulation-Recipe.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
[![Release](https://img.shields.io/github/v/release/jue-xu/Quantum-Simulation-Recipe?include_prereleases)](https://github.com/Jue-Xu/Quantum-Simulation-Recipe/releases)

This [python package](https://pypi.org/project/quantum-simulation-recipe/) contains ingredients for quantum simulation, such as the Hamiltonians and algorithmic primitives, mainly build on [qiskit](https://www.ibm.com/quantum/qiskit), [openfermion](https://github.com/quantumlib/OpenFermion).

## Install
```bash
conda create --name qs python=3.10
conda activate qs
pip install quantum-simulation-recipe
```

Expand All @@ -19,7 +21,8 @@ H = spin_ham.Nearest_Neighbour_1d(4)
H.ham
```
More details
https://github.com/Jue-Xu/Quantum-Simulation-Recipe/tree/main/tests/test.ipynb
<!-- https://github.com/Jue-Xu/Quantum-Simulation-Recipe/tree/main/tests/test.ipynb -->
https://jue-xu.github.io/Quantum-Simulation-Cookbook

## Content
### Common Hamiltonians
Expand Down Expand Up @@ -51,3 +54,5 @@ https://github.com/Jue-Xu/Quantum-Simulation-Recipe/tree/main/tests/test.ipynb
- QSP
- ITE

## Misc
Support Jax
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

setuptools.setup(
name="quantum-simulation-recipe",
version='0.1.0',
version='0.1.1',
# version=package_version,
# author="Jue XU",
author_email="[email protected]",
Expand Down

0 comments on commit ada55be

Please sign in to comment.