Skip to content
This repository has been archived by the owner on Dec 6, 2017. It is now read-only.

Latest commit

 

History

History
47 lines (35 loc) · 1.47 KB

index.rst

File metadata and controls

47 lines (35 loc) · 1.47 KB

Jumos: customisable molecular simulation package

is a package for molecular simulations written using the Julia language. It provides a set of customisable blocks for running molecular simulations, and developing novel algorithm for each part of a simulation. Every algorithm (potential computation, long range interactions, pair lists computing, outputs, etc.) can easily be customised.

Note

This package is in a very alpha stage, and still in heavy developement. Breaking changes can occurs in the API without any notice at any time.

This documentation is divided in two parts: first come the user manual, starting by some explanation about usal algorithms in simulations <simulation-steps> and an example <simulation-usage> of how we can use to run a molecular dynamic simulation. The second part is the developer documentation, exposing the internal of , and how we can use them to programm new algorithms.

Installation

uses the 0.4 prerelease version of Julia, and can be installed at julia prompt with the Pkg.add("Jumos") command. You also can run the unit tests with the Pkg.test("Jumos") command.

User manual

overview/index universe/index simulations/index utils/index

Extending

extending/index