1803
Comment:
|
2390
|
Deletions are marked like this. | Additions are marked like this. |
Line 2: | Line 2: |
[[EMEN2]] is dependent on several other packages. With the exception of Python, which is generally up to date and well-packaged on most systems, I recommend downloading the latest version from the project's site and installing it, or using easy_install for the package if possible. (Linux/Mac package management systems often have out of date software.) | |
Line 4: | Line 3: |
If I have specified a version, it is the minimum version I have tested EMEN2 with. I cannot guarantee success with versions earlier than noted. | [[EMEN2]] uses a "progressive enhancement" approach to dependencies -- functionality is increased with additional dependency libraries. |
Line 6: | Line 5: |
* Python 2.5+ * (note: do not use Python 3.0+) |
For basic client usage, no dependencies are required beyond the basic Python environment; the GUI clients require PyQt4. On the server side, Berkeley DB and bsddb3 are required for basic functionality. If you want to run the web server, you will also need Twisted, Markdown, and Mako. Additional server features, such as thumbnails and plotting, are provided by EMAN2, matplotlib, and ImageMagick. == Python Environment == * Python 2.6+ * Note: do not use Python 3.0+ |
Line 10: | Line 15: |
* Berkeley DB 4.8.24+ | == Core Database == * Berkeley DB 5.0.x |
Line 12: | Line 20: |
* Note: Berkeley DB 5.x has not been tested | * Note: Relatively recent 4.8.2x release are probably OK as well |
Line 15: | Line 23: |
* bsddb3 4.8.4+ (latest) | * bsddb3 5.0.x |
Line 17: | Line 25: |
* Note: Berkeley DB 5.x has not been tested | * Note: Relatively recent 4.8.2x release are probably OK as well |
Line 20: | Line 28: |
== Web Server == |
|
Line 24: | Line 34: |
* "easy_install makotemplates" * demjson (latest) * A fast, compliant JSON module * http://deron.meranda.us/python/demjson/ * "easy_install demjson" * note: EMEN2 may use the Python json standard library in the future |
* "easy_install mako" |
Line 37: | Line 41: |
* PyYAML (latest) * Configuration file is YAML-based * "easy_install yaml" |
* Markdown * Simplified rich-text editing * "easy_install Markdown" == Web Server: Optional == * EMAN2 (recommended) * EMAN2 is optionally used to generate browsable micrograph previews. * http://ncmi.bcm.edu/ncmi/software/counter_222/software_86 * Matplotlib (recommended) * Plotting support * Note: commonly installed with EMAN2 * "easy_install matplotlib" * ImageMagick (recommended) * Thumbnail and document preview support * Commonly installed on Linux * http://www.imagemagick.org/ |
Line 42: | Line 62: |
* Network encryption "easy_install pyOpenSSL" | * Network encryption * "easy_install pyOpenSSL" |
Line 44: | Line 65: |
* EMAN2 * EMAN2 is optionally used to generate browsable micrograph previews. * http://ncmi.bcm.edu/ncmi/software/counter_222/software_86 |
== GUI Client == * PyQt4 * Python bindings for Nokia's Qt toolkit * You will want to install this as a binary, unless you are a masochist. On Windows, there is a simple to use binary installer. Like matplotlib, this is commonly available as a binary an EMAN2 package. * http://www.riverbankcomputing.co.uk/software/pyqt/download |
EMEN2 Dependencies
EMEN2 uses a "progressive enhancement" approach to dependencies -- functionality is increased with additional dependency libraries.
For basic client usage, no dependencies are required beyond the basic Python environment; the GUI clients require PyQt4.
On the server side, Berkeley DB and bsddb3 are required for basic functionality. If you want to run the web server, you will also need Twisted, Markdown, and Mako. Additional server features, such as thumbnails and plotting, are provided by EMAN2, matplotlib, and ImageMagick.
Python Environment
- Python 2.6+
- Note: do not use Python 3.0+
Core Database
- Berkeley DB 5.0.x
- BDB is the storage and transactional backend for EMEN2
- Note: Relatively recent 4.8.2x release are probably OK as well
http://www.oracle.com/technology/software/products/berkeley-db/index.html
- bsddb3 5.0.x
- Python bindings for Berkeley DB
- Note: Relatively recent 4.8.2x release are probably OK as well
- "easy_install bsddb3"
Web Server
- Mako Templates (latest)
- A simple, fast templating system for Python
- "easy_install mako"
- Twisted 10.x+
- An event-driven networking engine written in Python
- "easy_install twisted"
- Markdown
- Simplified rich-text editing
- "easy_install Markdown"
Web Server: Optional
- EMAN2 (recommended)
- EMAN2 is optionally used to generate browsable micrograph previews.
- Matplotlib (recommended)
- Plotting support
- Note: commonly installed with EMAN2
- "easy_install matplotlib"
ImageMagick (recommended)
- Thumbnail and document preview support
- Commonly installed on Linux
- pyOpenSSL
- Network encryption
- "easy_install pyOpenSSL"
GUI Client
- Python bindings for Nokia's Qt toolkit
- You will want to install this as a binary, unless you are a masochist. On Windows, there is a simple to use binary installer. Like matplotlib, this is commonly available as a binary an EMAN2 package.