flowerMD is a modular “wrapper” package for molecular dynamics (MD) simulation pipeline development, designed to enable fast, reproducible, end-to- end simulation workflows with minimal user effort. This package is a wrapper for MoSDeF packages and Hoomd-Blue with a focus on simulating soft matter systems.
An object-oriented design makes flowerMD extensible and highly flexible. This is bolstered by a library-based approach to system initialization, making flowerMD agnostic to system identity, forcefield, and thermodynamic ensemble, and allowing for growth on an as-needed basis.
Installing flowermd
from the conda-forge
channel can be achieved by adding conda-forge
to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
Once the conda-forge
channel has been enabled, flowermd
can be installed with conda
:
conda install flowermd
or with mamba
:
mamba install flowermd
Installing from source for development:
Clone this repository:
git clone git@github.com:cmelab/flowerMD.git
cd flowerMD
Set up and activate environment:
conda env create -f environment-dev.yml
conda activate flowermd
python -m pip install -e .
Please check out the tutorials for a detailed description of how to use flowerMD and what functionalities it provides.
Documentation is available at https://flowermd.readthedocs.io
We welcome all contributions to flowerMD. Please see contributing guidelines for more information.