Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
svandenhaute authored Jul 28, 2024
1 parent c31bc49 commit 1170519
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
[![DOI](https://flat.badgen.net/static/DOI/10.1038%2Fs41524-023-00969-x)](https://www.nature.com/articles/s41524-023-00969-x)



# Scalable Molecular Simulation

Psiflow is a scalable molecular simulation engine for chemistry and materials science applications.
Expand All @@ -23,6 +22,11 @@ Users may define arbitrarily complex workflows and execute them **automatically*
To achieve this, psiflow is built using [Parsl](https://parsl-project.org/): a parallel execution library which manages job submission and workload distribution.
As such, psiflow can orchestrate large molecular simulation pipelines on hundreds or even thousands of nodes.


<p align="center">
<img src="https://github.com/molmod/psiflow/blob/main/docs/overview.png" width="500" class="center">
</p>

# Setup

Use the following one-liner to create a lightweight [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html) Python environment with all dependencies readily available:
Expand All @@ -42,6 +46,9 @@ The only requirement is that you set up a Python environment and provide a `conf

# Examples

<img src="https://github.com/molmod/psiflow/blob/main/docs/api_example.png" width="1000" class="center">


- [Replica exchange molecular dynamics](https://github.com/molmod/psiflow/tree/main/examples/alanine_replica_exchange.py) | **alanine dipeptide**: replica exchange molecular dynamics simulation of alanine dipeptide, using the MACE-MP0 universal potential.
The inclusion of high-temperature replicas allows for fast conformational transitions and improves ergodicity.
- [Geometry optimizations](https://github.com/molmod/psiflow/tree/main/examples/formic_acid_transition.py) | **formic acid dimer**: approximate transition state calculation for the proton exchange reaction in a formic acid dimer,
Expand Down

0 comments on commit 1170519

Please sign in to comment.