tREADME.md - granular - granular dynamics simulation
(HTM) git clone git://src.adamsgaard.dk/granular
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
tREADME.md (1267B)
---
1 # granular
2
3 Simulate granular mechanics with realistic physics and minimal
4 external dependencies.
5
6
7 ## Building and installing
8
9 To build a fast version for performance, compile with the following
10 command:
11
12 $ make CFLAGS="-O3"
13
14 To build with debug symbols for development, compile with the command:
15
16 $ make CFLAGS="-Wall -Wextra -pedantic -g"
17
18
19 ## Usage
20
21 This software consists of a series of programs each serving individual
22 purposes. The user combines these programs in a way suitable for
23 their needs.
24
25 The purpose, usage, and input/output formats of all programs are
26 documented in their respective man pages, available after `make
27 install`:
28
29 man 5 granular # documentation on the general granular format
30 man granular # simulate interaction over time
31 man granular2img # conversion of the granular format to images
32 man granular2vtu # conversion of the granular format to VTK format
33 man granularenergy # calculate kinetic and potential energy
34 man granulargrain # program for creating a single grain
35 man granularpacking # create an assemblage of grains
36
37 There are usage examples (*.sh) which are by default installed to
38 /usr/local/share/doc/granular/.
39
40
41 ## Author
42
43 Anders Damsgaard https://adamsgaard.dk