Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BCarnaval committed Jun 7, 2023
1 parent edbe5c5 commit 1cd5749
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ where $c^\dagger$ and $c$ are respectively the second quantization creation/anih

</div>

## Table of contents
# Table of contents

- [Requirements](#requirements)
- [Rust](#rust)
Expand All @@ -26,7 +26,7 @@ where $c^\dagger$ and $c$ are respectively the second quantization creation/anih

- [Todo](#todo)

## Requirements
# Requirements

### Rust

Expand All @@ -48,7 +48,7 @@ $ brew install lapack openblas
```
For additionnal details on installation I suggest to check for online support such as: [linux](https://coral.ise.lehigh.edu/jild13/2016/07/27/install-lapack-and-blas-on-linux-based-systems/), and [windows](https://icl.utk.edu/lapack-for-windows/).

## Installation
# Installation

To use the program, users should clone this repository on their computer using the command
```bash
Expand All @@ -64,7 +64,7 @@ $ cargo test
```
at the root of the project. If all the tests pass, you are ready to use the program!

## Usage
# Usage

### Compute eigenvalues

Expand Down Expand Up @@ -143,7 +143,7 @@ pub fn get_eigenvalues(&self) {
```
and it will print all the differents blocks of the hamiltonian that are diagonalized to find the eigenvalues.

## Todo
# Todo

- [x] Complete the `README.md`
- [x] Include periodic boundary conditions to hoppings operator (phase correction)
Expand Down

0 comments on commit 1cd5749

Please sign in to comment.