Skip to content

Commit 9be78ac

Browse files
committed
Update ReadME
1 parent d5f005d commit 9be78ac

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,17 @@
99

1010
## Overview
1111

12-
MISPR is a software that executes, manages, and stores computational materials science
13-
simulations. It contains pre-defined density functional theory (DFT) and molecular dynamics (MD) workflows to calculate and analyze different
14-
properties of materials. MISPR uses [MDPropTools][mdproptools] to perform MD analysis.
12+
MISPR is a free, open-source software for executing, managing, and storing computational materials science simulations. Features of MISPR include:
13+
14+
- Predicts various materials properties through pre-defined workflows
15+
- Integrates density functional theory (DFT) and molecular dynamics (MD) simulations seamlessly
16+
- Processes, analyzes, and visualizes simulation results with built-in utilities
17+
- Handles errors automatically using recipe-like fixes
18+
- Builds and manages computational databases in MongoDB backend for easy querying, analysis, and sharing
19+
- Supports multiple queuing systems via FireWorks including SLURM, PBS, SGE, etc.
20+
- Scales architecture to handle computations from individual materials to thousands of compounds
21+
- Modifies and chains workflows together flexibly
22+
- Leverages open-source libraries including [pymatgen][pymatgen], [custodian][custodian], and [FireWorks][fireworks]
1523

1624
## Workflows
1725

@@ -34,7 +42,12 @@ A standard workflow for performing classical MD simulations of liquid solutions
3442
3. Build initial system configuration
3543
4. Create LAMMPS data file containing initial atomic coordinations, molecular topology, and force field parameters
3644
5. Run two step energy minimization, NPT equilibration run, melting and quenching, and an NVT production run
37-
6. Perform analysis using the generated log and trajectory files (radial distribution function, coordination number, cluster analysis, mean squared displacement and diffusion)
45+
6. Perform analysis using the generated log and trajectory files (radial distribution function, coordination number, cluster analysis, mean squared displacement and diffusion) using [MDPropTools][mdproptools]
46+
47+
### Hybrid Workflows
48+
49+
- **General**: A workflow that combines the ESP DFT workflow with the MD workflow described above
50+
- **NMR**: A workflow that first runs the general hybrid workflow, then analyzes solvation shells from MD trajectories, and finally runs the NMR DFT workflow on representative solvation structures to predict chemical shifts
3851

3952
All these workflows are easily customizable and can be modified to suit specific research needs.
4053

@@ -74,6 +87,9 @@ MISPR is a free, open-source software package (distributed under the [MIT licens
7487
[commit-badge]: https://img.shields.io/github/commit-activity/m/molmd/mispr
7588
[commit-link]: https://github.com/molmd/mispr/commits/master
7689
[mdproptools]: https://github.com/molmd/mdproptools
90+
[fireworks]: https://materialsproject.github.io/fireworks/
91+
[pymatgen]: https://pymatgen.org
92+
[custodian]: https://materialsproject.github.io/custodian/
7793
[install-docs]: https://molmd.github.io/mispr/html/installation/index.html
7894
[mispr-website]: https://molmd.github.io/mispr/
7995
[api-docs]: https://molmd.github.io/mispr/html/py-modindex.html

0 commit comments

Comments
 (0)