Skip to content
A set of tutorials to introduce new users to the MoSDeF (Molecular Simulation Design Framework) toolkit
Jupyter Notebook Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
foyer_tutorials @ 8c31ce8
full-examples
mbuild_tutorials @ 8d7cb53
mff_test1
mff_test2
utils
.gitignore
.gitmodules
README.md
environment.yml
foyer-overview.ipynb
mbuild-overview-STUDENT.ipynb
mbuild-overview.ipynb
overview.ipynb
postBuild

README.md

MoSDeF: A Molecular Simulation and Design Framework

MoSDeF consists of a collection of Python packages aimed at simplifying the creation, atom-typing, and simulation of complex molecular models - with a particular focus on the use of programmatic routines that allow for screening over large structural parameter spaces and the encapsulation of these routines to facilitate reproducibility.

MoSDeF is founded around two core Python packages:

  • mBuild: A hierarchical, component-based molecule builder
  • Foyer: A package for atom-typing as well as applying and disseminating forcefields

Installation

To access the MoSDeF tutorials clone this repository using:

git clone --recurse-submodules https://github.com/mosdef-hub/mosdef_tutorials.git

Note the addition of the --recurse-submodules flag to the standard git clone command. The mBuild and Foyer tutorials are included here as submodules and this flag is necessary to download them.

Tutorials

This repository features a collection of tutorials and examples to help new users get familiarized with the MoSDeF toolkit. These tutorials/examples are organzied as follows:

mBuild

  • mBuild 00: Getting Started
  • mBuild 01: Basic Functionality
  • mBuild 02: Resuing Components
  • mBuild 03: Connecting Components with Ports
  • mBuild 04: Constructing Larger Compounds
  • mBuild 05: Creating Flexible Classes
  • mBuild 06: Setting Up Bulk Systems
  • mBuild 07: Energy Minimization
  • mBuild 08: Building Polymers
  • mBuild 09: Surface Functionalization

The mBuild tutorials can also be accessed through the mBuild tutorials repository.

Foyer

  • Foyer 00: Getting Started
  • Foyer 01: SMARTS and Overrides
  • Foyer 02: SMARTS for Non-Atomistic Systems
  • Foyer 03: Creating Force Field Files

The Foyer tutorials can also be accessed through the Foyer tutorials repository.

A series of full examples demonstrating how systems constructed with mBuild and Foyer can be used for performing simulations are currently under construction.

You can access this repository and run these tutorials interactively in-browser through our Binder link: Binder

If you would like a more general introduction to these tools, we have also included an "Overview" notebook that can be accessed through the following Binder link: Binder

Additionally, if you would like to access only the mBuild or only the Foyer tutorials, these can be accessed through the following Binder links:

mBuild Binder

Foyer Binder

You can’t perform that action at this time.