Giter Club home page Giter Club logo

jax-md's Introduction

Molecular Dynamics using JAX

This is a simple repository to get use to JAX.

JAX-MD provide an efficient Molecular Dynamics (MD) simulation solution using JAX.

Lennard-Jones potential is used as inter-atomic potential: $$V_{ij}(r) = 4\epsilon \left[ \left( \frac{\sigma}{r} \right)^{12} - \left( \frac{\sigma}{r} \right)^{6} \right]$$

$r$ being the inter-atomic distance between the atom $i$ and $j$, $\epsilon$ the depth of the potential well and $\sigma$ the "cutoff".

The velocity Verlet integrator is used to propagate the system along the time.

Installation

To install JAX-MD use inside the cloned repository:

pip install -e .

Usage

After the installation, to run a molecular dynamics simulation one can use:

jaxdyn param_file.yaml

With param_file.yaml being a .yaml file to read the simulation parameters from.

Create an input file

JAX-MD uses .yaml file as input. This file contains the parameters used during the simulation. These parameters are:

  • xyz_file : Path to the .xyz file containing the system.
  • key : Key random generator, used if xyz_file is not given to initialize the system's position as random.
  • num_particules : Number of particules in the randomly initialized system.
  • box_size : Size of the simulation box.
  • dt : Time step.
  • n_step : Number of time step, ie length of the simulation.
  • epsilon : $\epsilon$ parameter in the Lennard-Jones potential.
  • sigma : $\sigma$ parameter in the Lennard-Jones potential.
  • display_energy : Display energies of the system as a function of the time.
  • display_animation : Display a 2D projection of the simulation.
  • printing_step : Print the system energy every nth step.
  • writing_step : Write the system coordinates into a trajectory file every nth step.
  • center : Center the molecule in the PBC box

jax-md's People

Contributors

comecattin avatar

Stargazers

 avatar

Watchers

 avatar

jax-md's Issues

Write and print result

Write and print the result only every n'th time steps. This should be user's choice but have a default.

Write ARC file

Write output from the dynamics inside an ARC file. This file should can be open using VMD after the simulation.

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.