Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wztzjhn committed Sep 2, 2024
1 parent 33324ce commit f5a2dc3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![C/C++ CI](https://github.com/wztzjhn/quantum_basis/actions/workflows/c-cpp.yml/badge.svg?branch=master)](https://github.com/wztzjhn/quantum_basis/actions/workflows/c-cpp.yml)
# Quantum Basis
Basis of condensed matter quantum lattice problems, for usage in exact diagonalization (ED). The code is designed for any general bosonic or fermionic problem (or a mix of both), as long as the user can provide the [matrix form of the elementary operators](docs/Manual.pdf) of the Hamiltonian.
Basis of condensed matter quantum lattice problems, for usage in exact diagonalization (ED). The code is designed for any general bosonic or fermionic problem (or a mix of both), as long as the user can provide the [matrix form of the elementary operators](docs/Manual.pdf) (see Chapter 2 for details) of the Hamiltonian.

## Human-friendly usage (Heisenberg model as *example*)
*Note: the grammars below may differ slightly from the acutal code, please refer to the folder "examples" for exact usage.*
Expand Down

0 comments on commit f5a2dc3

Please sign in to comment.