Differences between revisions 33 and 56 (spanning 23 versions)

Installing and configuring EMEN2

EMEN2 has a number of dependencies, which are described on the dependencies page. However, because EMEN2 is often used with EMAN2, we have packaged all of the EMEN2 dependencies along with binary builds of EMAN2, which greatly simplifies installation. See the EMAN2 page for information on installing EMAN2 and the notes below. On Linux, we usually install EMAN2 into $HOME/EMAN2; make sure to run the "EMAN2/eman2-installer" script and add the resulting EMAN2 init script (EMAN2/eman2.bashrc) to your shell rc (usually $HOME/.profile or $HOME/.bashrc).

Note: After reading this document, you can view a walk-through of a successful installation.

Install EMEN2

EMEN2 can be installed using either Python easy_install:

sudo python -m easy_install -U emen2

Note the "-U" flag will upgrade emen2 to the current version if it is already found.

Alternatively, you may install EMEN2 by downloading the source, unpacking, and running the setup.py script:

Download EMEN2

python ./setup.py build
sudo python ./setup.py install

Note: Installing EMEN2 with EMAN2

If you are using an EMAN2 binary distribution to take care of all the dependencies, you will need to use EMAN2's Python environment on Linux and Windows. On Linux, assuming you installed EMAN2 into $HOME/EMAN2, you would use $HOME/EMAN2/Python/bin/python as the interpreter. This will ensure that the correct dependencies are loaded and EMEN2 is installed in the correct location. On Mac OS X, EMAN2 uses the system default Python environment, so no special action is required. Example:

$HOME/EMAN2/Python/bin/python -m easy_install -U emen2

Creating an EMEN2 database environment

Here is a "quick start" guide to initialize an EMEN2 DB and start the web server. The "-h" argument in the scripts below are references to a directory to keep the EMEN2 DB; the directory will be created if it does not exist.

python -m emen2.db.create -h $HOME/testdb -e default,em,site

This will prompt for a "root" account password, and create a minimal EMEN2 environment. The email address will be used for password recovery and system messages if a mail server is provided in the configuration. The password can be left empty, but the system will not be secure at all.

To start the EMEN2 web server with default settings:

python -m emen2.web -h $HOME/testdb -e default,em,site

You will be able to access the server at http://localhost:8080

Another way to start the web server is to use the "emen2ctl" program:

emen2ctl restart -h $HOME/testdb -e default,em,site

This will daemonize emen2, and log all messages to a file, $HOME/testdb/twistd/emen2.log.

Finally, if you want to start EMEN2 at system boot, see EMEN2 Startup for details on using the emen2 init script.

-  ⇤ ← Revision 33 as of 2010-11-23 08:35:21 → 
  Size: 665
  Editor: root
  Comment:
+   ← Revision 56 as of 2013-05-14 16:04:00 → ⇥
  Size: 3041
  Editor: IanRees
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 3:
-<<TableOfContents>>
+EMEN2 has a number of dependencies, which are described on the [[EMEN2/Dependencies|dependencies]] page. However, because EMEN2 is often used with [[EMAN2]], we have packaged all of the EMEN2 dependencies along with binary builds of EMAN2, which greatly simplifies installation. See the [[EMAN2]] page for information on installing EMAN2 and the notes below. On Linux, we usually install EMAN2 into $HOME/EMAN2; make sure to run the "EMAN2/eman2-installer" script and add the resulting EMAN2 init script (EMAN2/eman2.bashrc) to your shell rc (usually $HOME/.profile or $HOME/.bashrc).
 Line 5:
-= Install Dependencies =
+'''Note:''' After reading this document, you can view a [[EMEN2/Install/Example|walk-through of a successful installation]].
 Line 7:
-You will first need to install the various [[EMEN2/Dependencies|EMEN2 dependencies]]. They are all straight-forward to install, and can generally be installed using Python's easy_install system.
+= Install EMEN2 =
 Line 9:
-= Quick Start =

Here is a "quick start" guide to install EMEN2, initialize an EMEN2 DB, and start the web server. The "-h" argument in the scripts below are references to a directory to keep the EMEN2 DB; the directory will be created if it does not exist.
+EMEN2 can be installed using either Python easy_install:
-Line 14:
+Line 12:
-python -m emen2.clients.clone -h $HOME/test_db -- --defs
python -m emen2.web.server -h $HOME/test_db
+sudo python -m easy_install -U emen2
-Line 17:
+Line 14:
+Note the "-U" flag will upgrade emen2 to the current version if it is already found.

Alternatively, you may install EMEN2 by downloading the source, unpacking, and running the setup.py script:

[[http://pypi.python.org/pypi/emen2|Download EMEN2]]

{{{
python ./setup.py build
sudo python ./setup.py install
}}}

'''Note:''' Installing EMEN2 with EMAN2

If you are using an EMAN2 binary distribution to take care of all the dependencies, you will need to use EMAN2's Python environment on Linux and Windows. On Linux, assuming you installed EMAN2 into $HOME/EMAN2, you would use $HOME/EMAN2/Python/bin/python as the interpreter. This will ensure that the correct dependencies are loaded and EMEN2 is installed in the correct location. On Mac OS X, EMAN2 uses the system default Python environment, so no special action is required. Example:

{{{
$HOME/EMAN2/Python/bin/python -m easy_install -U emen2
}}}

= Creating an EMEN2 database environment =

Here is a "quick start" guide to initialize an EMEN2 DB and start the web server. The "-h" argument in the scripts below are references to a directory to keep the EMEN2 DB; the directory will be created if it does not exist.

{{{
python -m emen2.db.create -h $HOME/testdb -e default,em,site
}}}

This will prompt for a "root" account password, and create a minimal EMEN2 environment. The email address will be used for password recovery and system messages if a mail server is provided in the configuration. The password can be left empty, but the system will not be secure at all.

To start the EMEN2 web server with default settings:

{{{
python -m emen2.web -h $HOME/testdb -e default,em,site
}}}

You will be able to access the server at http://localhost:8080

Another way to start the web server is to use the "[[EMEN2/emen2ctl|emen2ctl]]" program:

{{{
emen2ctl restart -h $HOME/testdb -e default,em,site
}}}

This will daemonize emen2, and log all messages to a file, $HOME/testdb/twistd/emen2.log.

Finally, if you want to start EMEN2 at system boot, see [[EMEN2/Startup|EMEN2 Startup]] for details on using the [[EMEN2/emen2ctl|emen2 init script]].