INSTALL 1.79 KB
Newer Older
1
******************************************************************************
2
*
3
*                  ESPResSo installation
4
*
5 6
******************************************************************************

7 8 9
The ESPResSo compilation and installation process is decribed in
detail in the ESPResSo user's guide. When you have obtained the
sources in a .tar.gz file, the user's guide can be found in the file
10
"index.html" in the subdirectory "doc/sphinx/html/" relative to the directory where
11
this file resided.
12

13
When you have obtained the sources from the git repository or by other
14
means, the user's guide can always be found on the ESPResSo-Homepage at
15

16
	http://espressomd.org/html/doc/
17 18


19 20
QUICK START
-----------
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
The recommended way is to build by the cmake tool.
CMake recommends to build in a build directory not inside the
source. On Linux you can create and enter directory in a location
of your choice by

> mkdir <path-to-build-dir> && cd <path-to-build-dir>

Then you can run cmake and build ESPResSo by

> cmake <path-to-espresso-source>
> make

If you have installed the curses frontend to cmake you can see
and modify the build options graphically by running

> ccmake <path-to-espresso-source>

When these steps have completed successfully, you can run Espresso with
help of the command

41
> ./pypresso
42

43 44 45 46 47
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.

48

49 50
LICENSE
-------
51
Copyright (C) 2010,2011,2012,2013,2014 The ESPResSo project
52 53 54 55 56

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.