|
Size: 2131
Comment:
|
Size: 3064
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| Generally, you will want to create a user account for running emen2, e.g. 'emen2.' This has the benefit of working well with the default config file. Running as any other user also works fine, you will just have to change one or two paths in config.yml. | = Installing and configuring EMEN2 = |
| Line 3: | Line 3: |
| 1. Download the latest EMEN2 source code release and untar | 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: | Line 5: |
| 2. Create a directory for the Database Environment (referred to as $DB_HOME going forward. Reasonable default is /home/emen2/db/ ) | = Install EMEN2 = |
| Line 7: | Line 7: |
| Recommended: Set the $DB_HOME environment variable to this path for convenience | EMEN2 can be installed using either Python easy_install: |
| Line 9: | Line 9: |
| 3. Copy emen2/config.sample.yml to $DB_HOME/config.yml | {{{ sudo python -m easy_install -U -Z emen2 }}} |
| Line 11: | Line 13: |
| Edit the various settings in config.yml. See [[EMEN2/config.yml]]. Primarily, you will want to check the path and network settings. A simple configuration will have most EMEN2 directories (db, applog, archive, db_hotbackup, emen2files, etc.) placed under the path specified by the "&root" element, which is /home/emen2/ by default. | Note the "-U" flag will upgrade emen2 to the current version if it is already found. The "-Z" flag will prevent EMEN2 from being installed an a ".egg" zip file. |
| Line 13: | Line 15: |
| root: &root /home/emen2/ |
Alternatively, you may install EMEN2 by downloading the source, unpacking, and running the setup.py script: |
| Line 16: | Line 17: |
| 4. After config.yml is to your liking, run | [[http://pypi.python.org/pypi/emen2|Download EMEN2]] |
| Line 18: | Line 19: |
| python ./setup.py | {{{ python ./setup.py build sudo python ./setup.py install }}} |
| Line 20: | Line 24: |
| The rest of the $DB_HOME environment will be created, skeleton parameter/protocol definitions will be installed, and a root user created. You will be prompted on the shell for a root password. | '''Note: Installing EMEN2 with EMAN2''' |
| Line 22: | Line 26: |
| 5. Test web server | 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: |
| Line 24: | Line 28: |
| python ./TwistSupport.py | {{{ $HOME/EMAN2/Python/bin/python -m easy_install -U -Z emen2 }}} |
| Line 26: | Line 32: |
| You should be able to connect to this web server instance once it is "listening..." The default port is 8080. You may login with the root password you specified previously. | = Creating an EMEN2 database environment = |
| Line 28: | Line 34: |
| 6. Optional: Import Parameter/Protocol definitions from the NCMI Database. | 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. |
| Line 30: | Line 36: |
| python ./clients/clone.py -- --defs | {{{ python -m emen2.db --create -h $HOME/testdb }}} |
| Line 32: | Line 40: |
| Note: the first "--" is intentional and required at the moment. Command arguments for the local database go before "--", arguments to the cloning script go after ("--defs") | This will prompt for a "root" email address and 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. |
| Line 34: | Line 42: |
| You will be prompted for two sets of credentials. First, an NCMI DB account, and second, the root password for the local database. If you do not have an NCMI DB account, you may specify "anonymous" as the username, and your email address as the password. | To start the EMEN2 web server with default settings: |
| Line 36: | Line 44: |
| 6. Daemon | {{{ python -m emen2.web -h $HOME/testdb -e default,em,eman2,site }}} |
| Line 38: | Line 48: |
| After you are satisfied with your setup, you can run EMEN2 in the background | You will be able to access the server at http://localhost:8080 |
| Line 40: | Line 50: |
| python ./emen2control.py --start | Another way to start the web server is to run it as a Twisted Application, using twistd. {{{ twistd emen2 -h $HOME/testdb -e default,em,eman2,site }}} This will daemonize emen2, and log all messages to a file. You can specifiy the "-n -o" flags to twistd to prevent daemonization and print the log to stdout. 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]]. |
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).
Install EMEN2
EMEN2 can be installed using either Python easy_install:
sudo python -m easy_install -U -Z emen2
Note the "-U" flag will upgrade emen2 to the current version if it is already found. The "-Z" flag will prevent EMEN2 from being installed an a ".egg" zip file.
Alternatively, you may install EMEN2 by downloading the source, unpacking, and running the setup.py script:
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 -Z 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
This will prompt for a "root" email address and 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,eman2,site
You will be able to access the server at http://localhost:8080
Another way to start the web server is to run it as a Twisted Application, using twistd.
twistd emen2 -h $HOME/testdb -e default,em,eman2,site
This will daemonize emen2, and log all messages to a file. You can specifiy the "-n -o" flags to twistd to prevent daemonization and print the log to stdout.
Finally, if you want to start EMEN2 at system boot, see EMEN2 Startup for details on using the emen2 init script.