Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 1.13 KB

reference.md

File metadata and controls

17 lines (14 loc) · 1.13 KB

Reference

This is the full reference of the RAMPACK software. Installation instructions are available in Installation. An introduction and a brief summary of the most important use cases can be found in the Tutorial.

Detailed descriptions of particular aspects can be found in the following reference chapters:

  • Initial arrangement - description of all ways of initially arranging the particles
  • Input file - full documentation of the input file format
  • Observables - documentation of all observables that can be computed
  • Operation modes - documentation of all program modes
  • Output formats - description of all output formats the software can generate
  • Shapes - documentation of all shapes and supported interactions that can be used in simulations

There are also documents targeted for contributors:

  • Contributing - a general guide on the code style and how to contribute
  • Source code - a walkthrough of the most important source code modules and interfaces