Code Monkey home page Code Monkey logo

mdsuite's Introduction

zincware DOI madewithpython build docs license coverage Maintainability Binder

Introduction

MDSuite is a software designed specifically for the molecular dynamics community to enable fast, reliable, and easy-to-run calculations from simulation data.

If you want to start learning about the code, you can check out the docs here.

Installation

There are several ways to install MDSuite depending on what you would like from it.

One can simply install using

pip install mdsuite

If you would like to install it from source then you can clone the repository by running

git clone https://github.com/SamTov/MDSuite.git

Once you have cloned the repository, depending on whether you prefer conda or straight pip, you should follow the instructions below.

Installation with pip


  cd MDSuite
  pip install .

Installation with conda


   cd MDSuite
   conda create -n MDSuite python=3.8
   conda activate MDSuite
   pip install .

Documentation

There is a live version of the documentation hosted here. If you prefer to have a local copy, that can be built using sphinx by following the instructions below.

   cd MDSuite/docs
   make html
   cd build/html
   firefox index.html

HINT

Check out the MDSuite code through a jupyter notebook for a more user-friendly experience. You can take full advantage of the autocomplete features that are available for the calculators.

autocomplete

Disclaimer

MDSuite as far as is possible is tested against results validated by simulation engines or theoretical models. However, MDSuite or zincware are not liable for incorrect results produced when using the software.

mdsuite's People

Contributors

christophlohrmann avatar dependabot[bot] avatar fratorhe avatar kaiszuttor avatar marcbrueck avatar psomers3 avatar pythonfz avatar samtov avatar tobiasmerkt 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.