Giter VIP home page Giter VIP logo

mosdef_cassandra-1's Introduction

MoSDeF Cassandra

Citing License Codecov Azure

Overview

MoSDeF Cassandra is a Python wrapper for the Cassandra Monte Carlo code. The wrapper interfaces with the MoSDeF tools and provides a user-friendly interface to Cassandra without sacrificing any capabilities of Cassandra.

Warning

MoSDeF Cassandra is still in early development (0.x releases). The API may change unexpectedly.

Resources

  • Reference documentation: Examples, tutorials, guides, and API documentation
  • Installation guide: Instructions for installing MoSDeF Cassandra
  • GitHub repository: View the source code, contribute, and raise issues
  • Cassandra: Home of the Cassandra Monte Carlo package
  • MoSDeF tools: A generic collection of tools for constructing systems and applying forcefield parameters for particle-based simulations

Citation

Please cite MoSDeF Cassandra, Cassandra, and the MoSDeF suite of tools if you use this tool in your research. Details here.

Installation

Installation instructions are here. A conda installation will be added in the near future.

Examples

MoSDeF Cassandra provides a Python interface to Cassandra. The workflow consists of first constructing a system and move set. These two objects are passed to the runner that performs the Monte Carlo simulation with Cassandra. We use classes from the MoSDeF tools to structure some of the simulation inputs. The example below demonstrates an NVT Monte Carlo simulation of OPLS methane. No input files are required. Everything required to run the Monte Carlo calculation is contained in the script below.

import mbuild
import foyer
import mosdef_cassandra as mc

# Create a methane molecule from a SMILES string
methane = mbuild.load("C", smiles=True)

# Load the forcefield via foyer
ff = foyer.forcefields.load_OPLSAA()

# Apply the forcefield parameters to methane with foyer
methane_ff = ff.apply(methane)

# Define an empty simulation box
box = mbuild.Box([3.0, 3.0, 3.0])

# Define the boxes, species in the system, molecules in the box
ensemble = 'nvt'
box_list = [box]
species_list = [methane_ff]
molecules_to_add = [[100]]

# Create the System object
system = mc.System(box_list, species_list, mols_to_add=molecules_to_add)

# Create the Moves object
moves = mc.Moves(ensemble, species_list)

# Run a Monte Carlo simulation!
mc.run(
    system=system,
    moves=moves,
    run_type="equilibration",
    run_length=1000,
    temperature=300.0
)

Credits

Development of MoSDeF Cassandra was supported by the National Science Foundation under grant NSF Grant Number 1835874. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

mosdef_cassandra-1's People

Contributors

jennyfothergill avatar rsdefever avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.