|
Size: 2131
Comment:
|
Size: 1158
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 | <<TableOfContents>> |
| 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 Dependencies = |
| Line 7: | Line 7: |
| Recommended: Set the $DB_HOME environment variable to this path for convenience | 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 9: | Line 9: |
| 3. Copy emen2/config.sample.yml to $DB_HOME/config.yml | = Install EMEN2 = |
| Line 11: | Line 11: |
| 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. | EMEN2 can be installed using either Python easy_install: |
| Line 13: | Line 13: |
| root: &root /home/emen2/ |
{{{ sudo easy_install emen2 }}} |
| Line 16: | Line 17: |
| 4. After config.yml is to your liking, run | Or by downloading the source, unpacking, and using Python distutils: |
| 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. | = Quick Start = |
| Line 22: | Line 26: |
| 5. Test web server | 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. |
| Line 24: | Line 28: |
| python ./TwistSupport.py | {{{ python -m emen2.db.clone -h $HOME/test_db -- --defs python -m emen2.web.server -h $HOME/test_db }}} |
| Line 26: | Line 33: |
| 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. | You can also quickly access the native Python API, by invoking the emen2.db.admin module and interactive mode. |
| Line 28: | Line 35: |
| 6. Optional: Import Parameter/Protocol definitions from the NCMI Database. | {{{ python -i -m emen2.db.admin }}} |
| Line 30: | Line 39: |
| 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. 6. Daemon After you are satisfied with your setup, you can run EMEN2 in the background python ./emen2control.py --start |
Note: If you are using Python 2.7, you can use "-m emen2.web" and "-m emen2.db" |
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.
Install EMEN2
EMEN2 can be installed using either Python easy_install:
sudo easy_install emen2
Or by downloading the source, unpacking, and using Python distutils:
python ./setup.py build sudo python ./setup.py install
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.
python -m emen2.db.clone -h $HOME/test_db -- --defs python -m emen2.web.server -h $HOME/test_db
You can also quickly access the native Python API, by invoking the emen2.db.admin module and interactive mode.
python -i -m emen2.db.admin
Note: If you are using Python 2.7, you can use "-m emen2.web" and "-m emen2.db"