Skip to content

Commit 2fc65b2

Browse files
authored
add brief installation instructions to README
1 parent ab1f4ff commit 2fc65b2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ pymatgen-io-validation
44
This package is an extension to `pymatgen` for performing I/O validation. Specifically, this package checks for discrepancies between a specific calculation and a provided input set; it also checks for known bugs when certain input parameters are used in combination, alongside several other small checks. The motivation for creating this package was to ensure VASP calculations performed by groups outside of the Materials Project (MP) are compliant with MP data, thus enabling their raw data to be included in the MP Database.
55

66

7+
Installation
8+
=====
9+
10+
You can install this package by simply running
11+
12+
`pip install pymatgen-io-validation`
13+
14+
715
Usage
816
=====
917

0 commit comments

Comments
 (0)