Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yomichi committed Dec 6, 2022
1 parent fea2d4f commit da78f94
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
H-wave
========
# H-wave

H-wave is a program for performing unrestricted Hartree-Fock (UHF) approximation
for itinerant electron systems.
Expand All @@ -10,25 +9,40 @@ H-wave treats two types of UHF approximation: one is real-space and the other is
wavenumber-space UHF methods using translational symmetry. In the wavenumber space
UHF method, the input file defining the one-body and two-body interactions is
based on the Wannier90 format, and the program can be smoothly connected to
the softwares for deriving effective models from first-principles calculations.
the softwares for deriving effective models from first-principles calculations.

## Methods

### Methods
Hartree-Fock approximation

### Target models
## Target models

Hubbard model, multi-orbital Hubbard model

### Available physical quantities
## Available physical quantities

ground-state energy, free energy, etc.

## Requirement

Python3 with numpy, scipy, and other library packages

## Install
You can install H-wave and also get a manual for H-wave from a
[release page](https://github.com/issp-center-dev/H-wave/releases).

- From PyPI

``` bash
python3 -m pip install hwave
```

- From source (if you modify the program)

``` bash
python3 -m pip install DIRECTORY_OF_THE_REPOSITORY
```

## License

The distribution of the program package and the source codes for H-wave follow
GNU General Public License version 3
([GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html)).
Expand All @@ -46,6 +60,7 @@ of The Institute for Solid State Physics, The University of Tokyo.
- [User Manual](https://www.pasums.issp.u-tokyo.ac.jp/h-wave/en/doc/manual)

## Authors

Kazuyoshi Yoshimi,
Yuichi Motoyama,
Tatsumi Aoyama,
Expand Down

0 comments on commit da78f94

Please sign in to comment.