DynamO/README at master · ctianjin/DynamO · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
DynamO:- A general event-driven particle simulator. Please see the
website below for more information.

http://www.dynamomd.org

INSTALLATION
------------

Please see a full tutorial on the DynamO website. A quick summary is:

     make

And the executables will be installed into the bin directory. If you
want to install the executables to /usr/bin, run

     make install

Please pay attention to the output of the make command, as this scans
for required dependencies and will warn you if it is unable to build
DynamO!

SOURCE CODE
-----------

All of the source code is in the src/ directory. For more information
on the source code please see the src/README file. Also take a look at
the doxygen documentation (next section of this README).

DOCUMENTATION
-------------

Some resources are in the docs/ directory; however, the bulk of the
documentation will be available on the website.

If you want the latest, up to date doxygen documentation, just run

     doxygen

in the same directory as this README. This will generate HTML
docmentation in the docs/html directory.

TESTING
-------

There is a test script in scripts/test_dynarun.sh.

You can run some OpenCL and other tests by running

     make test

TROUBLESHOOTING/CONTRIBUTING
----------------------------

Please check the website and documentation if you're having any
trouble. If these don't answer your questions, just email
support@dynamomd.org. If you want to get involved, email support to
let us know about it and submit patches using github.

LICENSE
-------

Everything in DynamO is licensed GPL3 unless otherwise marked. Please
see LICENSE.txt for details of this license.