diff --git a/README.md b/README.md index c390b65..26a9e0f 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ [![Stable docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://mineralscloud.github.io/qha/) [![Build Status](https://travis-ci.com/MineralsCloud/qha.svg?branch=master)](https://travis-ci.com/MineralsCloud/qha) -| category | percent | downloads | -|-----------------|----------|-----------| -| with_mirrors | 100.00% | 2,801 | -| without_mirrors | 20.67% | 579 | -| Total | | 2,801 | +| category | percent | downloads | +| --------------- | ------- | --------- | +| with_mirrors | 100.00% | 2,801 | +| without_mirrors | 20.67% | 579 | +| Total | | 2,801 | Date range: 2023-04-20 - 2023-10-17 @@ -84,8 +84,6 @@ If you want to plot your results, in the same folder, run $ qha plot /path/to/settings.yaml ``` - - ## Structure of the `qha` package The `qha` source code consists of three major parts. @@ -134,7 +132,7 @@ This main folder contains three folders, license file, readme file, and setup fi `qha/v2p.py`: Contain the function `v2p` used to convert calculated properties on $(T, V)$ grid to $(T, P)$ grid; -`qha/input_maker.py`: Generate the input file for `qha` from results obtained from *ab initio* calculation; +`qha/input_maker.py`: Generate the input file for `qha` from results obtained from _ab initio_ calculation; `qha/out.py`: Functions used to write calculated properties into files.