Skip to content

Commit

Permalink
Merge pull request #1 from QunaSys/readme
Browse files Browse the repository at this point in the history
readme and requirements
  • Loading branch information
dchung0741 authored Jul 19, 2024
2 parents 3f41120 + 2bf6ce8 commit d4c6673
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# QURI Parts QSCI


QURI Parts QSCI an open source library for executing the [Quantum Selected Configuration Interaction (QSCI) algorithm.](https://arxiv.org/abs/2311.01105)



## Installation

QURI Parts requires Python 3.9.8 or later. Use `pip` to install QURI Parts QSCI.

```
pip install quri-parts-qsci
```

### Installation from local source tree

If you check out the QURI Parts repository and want to install from that local source tree, you can use `requirements-local.txt`.
In `requirements-local.txt`, optional components are commented out, so please uncomment them as necessary.

```
pip install -r requirements-local.txt
```

## Authors

QURI Parts developed and maintained by [QunaSys Inc.](https://qunasys.com/en). All contributors can be viewed on [GitHub](https://github.com/QunaSys/quri-parts-qsci/graphs/contributors).


## License

QURI Parts is licensed under [QunaSys Source Available License Version 1.0 (QSAL-1.0)](https://github.com/QunaSys/quri-parts-qsci/blob/main/LICENSE).
1 change: 1 addition & 0 deletions requirements-local.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
-e ./quri_pars_qsci

0 comments on commit d4c6673

Please sign in to comment.