Differences between revisions 11 and 31 (spanning 20 versions)
Revision 11 as of 2010-03-29 08:33:53
Size: 3030
Editor: root
Comment:
Revision 31 as of 2010-11-22 11:16:02
Size: 616
Editor: root
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
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. <<TableOfContents>>
Line 5: Line 5:
= Install Dependencies =
Line 6: 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.
Line 7: Line 9:
=== 1. Download the latest EMEN2 source code release and untar === = Download EMEN2 =
Line 9: Line 11:
{{{
cd /home/emen2
tar -xvzf emen2.03.28.2010.tar.gz
cd emen2
}}}
Download the latest EMEN2:
Line 15: Line 13:
If there is an existing source tree installed, you may want to rename it in case you want to revert to the previous version, e.g. mv emen2 emen2.old.03.20.2010. http://ncmi.bcm.edu/ncmi/software/software_details?selected_software=EMEN2
Line 17: Line 15:
If you have an existing database environment, I strongly recommend taking an additional tar backup of that directory before proceeding, in addition to normal backup procedures (log archive, db hot backup) in case you need to revert without the difficulty of performing a full recovery from archives. = Create EMEN2 Environment =
Line 19: Line 17:
= Edit Configuration =
Line 20: Line 19:
= Initialize EMEN2 Environment =
Line 21: Line 21:
=== 2. Create a directory for the Database Environment === = Test Web Server =
Line 23: Line 23:
(referred to as $DB_HOME going forward. Reasonable default is /home/emen2/db/ ) = Optional: Import =
Line 25: Line 25:
{{{
mkdir /home/emen2/db
cp config/config.sample.yml /home/emen2/db/config.yml
}}}
= Optional: Accelerator Module =
Line 30: Line 27:
Recommended: Set the $DB_HOME environment variable to this path for convenience. Place this in your .bash_profile or similar.

{{{
export DB_HOME=/home/emen2/db
}}}



=== 3. Copy emen2/config.sample.yml to $DB_HOME/config.yml ===

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.

{{{
  root: &root
    /home/emen2/
}}}



=== 4. After config.yml is to your liking, run ===

{{{
python ./setup.py
}}}

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.



=== 5. Test web server ===

{{{
python ./TwistSupport.py
}}}

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.



=== 6. Optional: Import Parameter/Protocol definitions from the NCMI Database. ===

{{{
python ./clients/clone.py -- --defs
}}}

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")

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.

=== 7. Run as daemon ===

After you are satisfied with your setup, you can run EMEN2 in the background

{{{
python ./emen2control.py --start
}}}
= Run as daemon =

Installing and configuring EMEN2

Install Dependencies

You will first need to install the various EMEN2 dependencies. They are all straight-forward to install, and can generally be installed using Python's easy_install system.

Download EMEN2

Download the latest EMEN2:

http://ncmi.bcm.edu/ncmi/software/software_details?selected_software=EMEN2

Create EMEN2 Environment

Edit Configuration

Initialize EMEN2 Environment

Test Web Server

Optional: Import

Optional: Accelerator Module

Run as daemon

EMEN2/Install (last edited 2013-06-27 06:59:34 by IanRees)