The Assimilation Project  based on Assimilation version 0.5.1435932971
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
README
Go to the documentation of this file.
1 /** @page README Assimilation README file
2 Welcome to the Assimilation README file :-D.
3 
4 This code builds with cmake, not the autofoo tools...
5 You can find a formatted version of this README online at
6 http://linux-ha.org/source-doc/assimilation/html/_r_e_a_d_m_e.html
7 A more detailed Getting Started guide can be found here
8 http://linux-ha.org/source-doc/assimilation/html/_getting_started.html
9 The project home page is at http://assimmon.org/ - check it out!
10 Please join the project mailing list at http://lists.community.tummy.com/cgi-bin/mailman/listinfo/assimilation
11 
12 
13 @section Dependencies
14 We like to have a reasonable number of things in the build environment.
15 - Cmake (and cpack) - http://cmake.org/
16 - C compiler (gcc, clang, or MS VC tools) - http://www.gnu.org/software/gcc/ <i>et al</i>
17 - make tools - like Gnu make, or MSVC - http://www.gnu.org/software/make/ <i>et al</i>
18 - Recent version of Glib2 - http://developer.gnome.org/glib/
19 - libpcap (or winpcap) - http://www.tcpdump.org/
20 - pkg-config (even for Windows) - http://www.freedesktop.org/wiki/Software/pkg-config
21 - valgrind - The 'C' level tests use it - http://valgrind.org/
22 - Testify - testing framework from Yelp - https://github.com/Yelp/Testify (<tt>pip install testify</tt>)
23 - doxygen (for documentation) - http://doxygen.org/
24 - dot (for doxygen graphs) - http://www.graphviz.org/
25 - Ctypesgen ( for the CMA code) http://code.google.com/p/ctypesgen/ (<tt>pip install ctypesgen</tt>)
26 
27 In addition, the following systems are needed in the runtime environment for the CMA:
28 - Neo4J - http://neo4j.org/
29 - py2neo - http://py2neo.org/ (<tt>pip install py2neo</tt>)
30 
31 @section GettingSource Getting Source for the Assimilation Monitoring Project
32 The source to the Assimilation Project can be found at http://hg.linux-ha.org/
33 
34 @section MakingIt Making The Assimilation Monitoring System from Source
35 If you know how to use cmake, you probably already know what to do.
36 
37 @subsection MakingItForLinux Making The Assimilation Monitoring System for *NIX Systems
38 If not, you can follow these instructions for *NIX type systems.
39 - Extract the source into "path-to-source-directory"
40 - mkdir "path-to-binary-directory"
41 - cd "path-to-binary-directory"
42 - cmake "path-to-source-directory"
43 - make install
44 
45 @subsection MakingRPMandDEBPackages Making RPM or DEB packages
46 The Cmake project provides cpack to make minimal RPM and DEB packages
47 Cpack also makes OS X and Windows packages - but that's untested.
48 Patches to make this work would be appreciated.
49 
50 The procedure for making packages is as follows:
51 
52 - Extract the source into "path-to-source-directory"
53 - mkdir "path-to-binary-directory"
54 - cd "binary-directory"
55 - cmake "path-to-source-directory"
56 - cpack
57 
58 If it can't figure out which kind of package to build, it will default to building RPMs.
59 Patches are being solicited to build Windows and OS X packages (read the cpack docs).
60 Other package formats aren't supported by cpack, and will have to be supported by other mechanisms.
61 
62 @subsection MakingItForWindows Making The Assimilation Monitoring System for Windows
63 - That's something we need to work out. An earlier verison of 'nanoprobe' did compile and run successfully on Windows
64 
65 @section TestingIt Running our Tests
66 There are currently two test modules that you can run after building it. They can be run
67 like this:
68 - cd testcode; sh path-to-source-tree/testcode/grind.sh # Assumes you have valgrind installed.
69 - cd testcode; ./pinger ::1 # Does a ping test of reliable UDP
70 - cd cma; testify tests # Runs significant python tests
71 
72 For the testcode piece, you have to be in the cma directory of <i>build tree</i>.
73 For the testify portion, you have to either be in the cma directory of the source tree
74 or the installed version in the python install place
75 (on my machine that's currently /usr/lib/python2.7/dist-packages/assimilation)
76 
77 
78 @section OtherTargets Other Make Targets
79 - doc - makes the documentation If you just want to view the latest version online,
80 go to http://assimmon.org/
81 
82 */