Skip to content

Commit

Permalink
update Readme + removal unneccesary files
Browse files Browse the repository at this point in the history
  • Loading branch information
gsilviHQS committed Sep 13, 2022
1 parent 6c560b8 commit c5f1e5a
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 661 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
This repositorycollects Python scripts and Jupyter notebooks that allow the user to test different variational algorithms. It contains our custom functions (e.g. VHA ansatz, PBO Hamiltonian)
that are built upon Qiskit libraries.

The repository is organized as follows:
- 'misc' folder contain the notebooks and scripts that showcase the variational algorithms
- 'qiskit_mod' contains our custom functions that are built upon Qiskit libraries as well as the QLM custom junction and helpers:
- 'qiskit_nat' the customize function built upon qiskit_nature
- 'qiskit_ter' the customize function built upon qiskit_terra
- 'my_junction.py' the QLM custom junction used to run the variational algorithms with QLM backends
- 'uploader_junction.py' helper to upload the junction to QLMaaS server, so that it can be found in the remote library
- 'wrapper2myqlm.py' helper to wrap the variational algorithms using QLM stack
- 'tests' unit tests for the variational algorithms

## Licence

The `LICENCE` file contains the default licence statement as specified in the proposal and partner agreement.
Expand Down
Loading

0 comments on commit c5f1e5a

Please sign in to comment.