1This directory contains the CSlib library which is required
2to use the MESSAGE package and its client/server commands
3in a LAMMPS input script.
4
5The CSlib library is included in the LAMMPS distribution.  A fuller
6version including documentation and test programs is available at
7http://cslib.sandia.gov.  It was developed by Steve Plimpton at Sandia
8National Laboratories.
9
10You can type "make lib-message" from the src directory to see help on
11how to build this library via make commands, or you can do the same
12thing by typing "python Install.py" from within this directory, or you
13can do it manually by following the instructions below.
14
15The CSlib can be optionally built with support for sockets using
16the open-source ZeroMQ (ZMQ) library.  If it is not installed
17on your system, it is easy to download and install.
18
19Go to the ZMQ website for details: http://zeromq.org
20
21-----------------
22
23Instructions:
24
251.  Compile CSlib from within cslib/src with one of the following:
26    % make lib_parallel     # build parallel library with ZMQ socket support
27    % make lib_serial       # build serial library with ZMQ support
28    % make lib_parallel zmq=no   # build parallel lib with no ZMQ support
29    % make lib_serial zmq=no     # build serial lib with no ZMQ support
30
312.  Copy the produced cslib/src/libcsmpi.a or libscnompi.a file to
32    cslib/src/libmessage.a
33
343.  Copy either lib/message/Makefile.lammps.zmq or Makefile.lammps.nozmq
35    to lib/message/Makefile.lammps, depending on whether you
36    build the library with ZMQ support or not.
37    If your ZMQ library is not in a place your shell path finds,
38    you can set the INCLUDE and PATH variables in Makefile.lammps
39    to point to the dirs where the ZMQ include and library files are.
40
41-----------------
42
43When these steps are complete you can build LAMMPS
44with the MESSAGAE package installed:
45
46% cd lammps/src
47% make yes-message
48% make mpi (or whatever target you wish)
49
50Note that if you download and unpack a new LAMMPS tarball, you will
51need to re-build the CSlib in this dir.
52