EMBOSS maintains a list of frequently asked questions (FAQs) with answers in the file FAQ
in the EMBOSS distribution, e.g.
/auser/emboss/emboss/FAQ |
The FAQ is given below and organised as follows:
General EMBOSS issues, licensing, availability etc or any areas not covered by other FAQs.
Hardware and software requirements, downloading etc.
Installation and compilation.
Databases configuration.
Post-installation setup and other administration issues not covered elsewhere.
EMBOSS key features for biologist end-users, how to request features etc,
Hardware and software requirements, downloading, installing and compiling, post-compilation setup etc.
EMBOSS support, mailing lists, reporting bugs, requesting features, training courses etc.
EMBOSS documentation.
Using the applications
EMBASSY packages and applications.
ACD syntax and files.
Use of EMBOSS interfaces.
Graphics.
EMBOSS internals and core features for software developers.
EMBOSS software development, programming libraries etc.
B.1. General | |||||||||||||||||||||||
Q: | Citation: Is there a reference I can cite for EMBOSS? | ||||||||||||||||||||||
A: | Rice P., Longden I. and Bleasby A. EMBOSS: The European Molecular Biology Open Software Suite. Trends in Genetics. 2000 16(6):276-277 | ||||||||||||||||||||||
B.2. Getting Started | |||||||||||||||||||||||
Q: | Can I get the latest code via CVS ? | ||||||||||||||||||||||
A: | Yes. Here is the information you will need. Make sure you have cvs on your system. Then log into the cvs server at
The password is
Or if you want to update a previously checked-out source code tree:
You can logout from the CVS server with:
This is a read only server. | ||||||||||||||||||||||
B.3. Administration (installation and compilation) | |||||||||||||||||||||||
| |||||||||||||||||||||||
Q: | How do I compile EMBOSS? | ||||||||||||||||||||||
A: | If this is the first time trying to compile all you need to do is:
The above will produce the EMBOSS programs in the
You should then add (e.g.)
If you wish to re-compile the code at any stage then you should type | ||||||||||||||||||||||
Q: | I have a Linux system and compilation ends prematurely saying that it can't find the lX11 libraries ... but I know I have X11 installed. | ||||||||||||||||||||||
A: | This should not happen with versions of EMBOSS later than 6.1.0 as the configuration will inform you of missing files and terminate at that stage. If you have a version of EMBOSS less than or equal to 6.1.0 then the problem is that you probably have the X11 server installed but you haven't installed the X11 development files. For example, on RPM distributions, you need to install:
After installing those system files you will need to:
and re-perform the | ||||||||||||||||||||||
Q: | I'm trying to compile EMBOSS with PNG support | ||||||||||||||||||||||
A: | Your system will need to have zlib (http://www.zlib.net: current version is 1.2.3), libpng (http://www.libpng.org: current version is 1.2.35) and gd (http://www.libgd.org: current version is 2.0.35). The version of gd must be >= 2.0.28 if it is to be used with EMBOSS. Note that the above packages often come with your operating system distribution but may not be installed by default i.e. they are optional packages which you can install at a later date. Also note that, as well as having the above system libraries installed, you must also have installed their associated development files (these typically have MacOSX users can often find the above packages available on the MacPorts site (http://www.macports.org). However, for some operating systems, there may be no freeware sites where you can find pre-compiled versions of zlib / libpng / gd and you may have to compile one or more of them from their source distributions (URLs given above). You can unpack the
To compile with the local version your EMBOSS ./configure line should now read:
| ||||||||||||||||||||||
Q: | When installing EMBOSS recently I get a load of errors due to libraries not found. The main problem is that I have an old version of libz but no libgd in my system libraries and EMBOSS looks there first to try to locate these libraries. I have the correct versions installed elsewhere. Are there any suggestions for setting the library search path or am I missing something really obvious? | ||||||||||||||||||||||
A: | There are the
and
flags. Did you try them? If the libraries are in | ||||||||||||||||||||||
Q: | How do I compile the CVS (developers) version? | ||||||||||||||||||||||
A: | You will need automake, autoconf, (GNU) make and libtool for this. The gcc compiler is recommended. The host cc compiler should work. (Note that some non-gcc compilers may need If you have system versions of the GNU tools that, by chance, are more recent than the GNU tools used in the EMBOSS source tree then typing
For more info on the configurability of the build try
| ||||||||||||||||||||||
Q: | Can you give an example of how to install an EMBASSY package? | ||||||||||||||||||||||
A: | Here is how to install PHYLIP given the various ways you can install the main EMBOSS package. From the anonymous cvs code.
From If you have done a full installation of EMBOSS using a 'prefix' e.g. you configured with
If, on the other hand, you did not do a
| ||||||||||||||||||||||
Q: | I have EMBOSS installed on our development server and I'm preparing a dispatch which will send it out to about 20 remote sites. I ran the configure with the My intention was to simply transfer the EMBOSS install directory and the
| ||||||||||||||||||||||
A: | It is inside the binaries. EMBOSS 'knows' the location of the files because it is picked up during the configure, when you build your copy, and included in the binaries. You can see it during compilation, especially of
To copy binaries, you need to define environment variable(s) to override the compile-time definitions, unless you can make the path (e.g.
and then, in the
or (this overrides it) you can use another environment variable:
| ||||||||||||||||||||||
Q: | I have downloaded the EMBOSS source and installed it for use at XYZ University without any difficulty. I've had some advice on configuring the software using | ||||||||||||||||||||||
A: | If you have SRS installed (so you have local SRS index files) you will have a local copy of the getz program, which is part of SRS. If you do not have SRS, you can build your own index files using dbxflat, dbxgcg (if you have GCG), dbiblast (if you have BLAST) and dbxfasta. This is the usual solution for sites that have no other database indexing in use. You can also use SRS servers remotely, to get single entries, using their URLs. No extra software is needed (EMBOSS just uses the HTTP protocol). Of course, if you really need to build your own SRS indexes you could install it. SRS is a commercial product, but academic licences are available. | ||||||||||||||||||||||
Q: | I am not getting full static files even when I configure with
| ||||||||||||||||||||||
A: | This most often happens when using GNU
| ||||||||||||||||||||||
B.4. Databases | |||||||||||||||||||||||
Q: | Where are the test databases? | ||||||||||||||||||||||
A: | In the directory | ||||||||||||||||||||||
B.5. Administration (other) | |||||||||||||||||||||||
Q: | How do I use my own private data file? | ||||||||||||||||||||||
A: | You may wish to amend one of the standard EMBOSS data files. Some of the data files you might wish to alter are the translation table files. transeq has been written to only read in one of the standard translation files:
These files are the only ones that you can specify to transeq. If you wish to create your own specialised translation table, then you should pick one of them to amend. For instance you may decide that you will use the file EGC.15 as you would never want to otherwise use it. Use the program embossdata to get a copy of this file:
Edit the file You may get confused with many copies of changed files floating about. To check which copy of a file is being used (the default
This shows that a copy of | ||||||||||||||||||||||
Q: | Can I alter the location of the ACD files? | ||||||||||||||||||||||
A: | EMBOSS will find the ACD files in the install directory or in the original source directory (depending on how you configured it) so there is usually no reason to change this. However, should you wish to do so then it can either be done in the
or by setting an environment variable on the command line:
| ||||||||||||||||||||||
B.6. Features | |||||||||||||||||||||||
Q: | I would like to know if EMBOSS can perform nucleotide contig assembly similar to the function that GCG gelproject / gelview has. And if yes, is there any size restriction on the number of base pair and the number of contigs? | ||||||||||||||||||||||
A: | EMBOSS does not cover the sort of contig assembly you describe. An EMBOSS wrapper for the MIRA package is available. | ||||||||||||||||||||||
B.7. Sequence Files and Formats | |||||||||||||||||||||||
| |||||||||||||||||||||||
Q: | How do you write sequences to different files instead of writing them all to one file? | ||||||||||||||||||||||
A: | EMBOSS is not good at writing multiple sequences to different files. You could try using nthseq to pull out one sequence at a time. You should consider using the | ||||||||||||||||||||||
Q: | What sequence formats are supported? | ||||||||||||||||||||||
A: | Tens of them(e.g.): gcg, embl, swissprot, fasta, ncbi, genbank, nbrf, codata, strider, clustal, phylip, acedb, msf, ig, staden, text, raw, asis etc. | ||||||||||||||||||||||
Q: | What is the difference between "TEXT" and "RAW" formats? | ||||||||||||||||||||||
A: |
| ||||||||||||||||||||||
Q: | What is "ASIS" format? | ||||||||||||||||||||||
A: | The "filename" is really the sequence. This is a quick and easy way of reading in a short fragment of sequence without having to enter it into a file. For example:
| ||||||||||||||||||||||
Q: | I have some very short protein sequences that EMBOSS thinks are nucleic sequences. How do I force EMBOSS to treat them as nucleic acid sequences? For example:
Here, water automatically (and wrongly) thinks that | ||||||||||||||||||||||
A: | For many sequence formats there is no way to specify the sequence type in the file, so EMBOSS has to guess. There is a flag that can force EMBOSS programs to treat sequences as nucleic or protein.
shows the full list of sequence qualifiers. If you follow the sequence USA with
The qualifier must follow the sequence to apply to one sequence, or can go at the start of the command line to refer to all sequences, for example:
You can also use | ||||||||||||||||||||||
B.8. Help and Support | |||||||||||||||||||||||
Q: | How do I report bugs? | ||||||||||||||||||||||
A: | |||||||||||||||||||||||
Q: | How do I contact the core development team? | ||||||||||||||||||||||
A: | Rather than email their personal addresses, for EMBOSS matters we request that you use the address:
This will ensure that your email will be seen by the appropriate developer and that it will get logged with our tracking system. | ||||||||||||||||||||||
Q: | Are there any mailing lists about EMBOSS? | ||||||||||||||||||||||
A: |
is an open list (anyone can join) for general announcements and discussions by users.
is a closed list (subscription requests have to be approved) for discussions by developers using EMBOSS.
is an open list for announcements of new releases. You can access the archives, subscribe/unsubscribe and alter the way email is sent to you (e.g. digests) by visiting:
| ||||||||||||||||||||||
Q: | Is there a tutorial? | ||||||||||||||||||||||
A: | See the EMBOSS tutorial in the EMBOSS Users Guide:
| ||||||||||||||||||||||
B.9. Documentation | |||||||||||||||||||||||
Q: | Where's the documentation? | ||||||||||||||||||||||
A: | All the documentation can be found at:
| ||||||||||||||||||||||
Q: | Where's the application documentation? | ||||||||||||||||||||||
A: | http://emboss.open-bio.org/rel/dev/apps/ and in the EMBOSS distribution, installed under
You can also use the EMBOSS application called tfm to display the plain text documentation of another application e.g.:
| ||||||||||||||||||||||
Q: | Is there a quick guide? | ||||||||||||||||||||||
A: | There is a dated quick guide provided with the source code as the file | ||||||||||||||||||||||
Q: | Is there a table of substitutes for GCG programs? | ||||||||||||||||||||||
A: | A list of GCG and corresponding EMBOSS applications is available in the EMBOSS Users Guide:
| ||||||||||||||||||||||
B.10. Applications | |||||||||||||||||||||||
Q: | Plotting with pepwheel gives interesting output.
gives a helical wheel plot but the residues are plotted so every two circles are sat on top of one another. | ||||||||||||||||||||||
A: | That is the correct answer. Instead of 3.6 residues per turn, (5 turns in 18 steps) you seem to have a helix with 8 turns in 18 steps (4 in 9). Try
but only if you are sure that is the way your helix goes. | ||||||||||||||||||||||
Q: | In prettyplot, how do you specify an output file name for the plot file? | ||||||||||||||||||||||
A: |
Creates
Creates | ||||||||||||||||||||||
Q: | I'm using the editor mse, but I don't know how to save my edited sequences at the end of the editing session. | ||||||||||||||||||||||
A: | Use | ||||||||||||||||||||||
B.11. EMBASSY | |||||||||||||||||||||||
Q: | What benefits do I gain from using the associated (EMBASSY) versions of software. | ||||||||||||||||||||||
A: | You can read any sequence type that EMBOSS can handle. | ||||||||||||||||||||||
A: | The associated software will use the EMBOSS ACD files so the naming of output/input files is taken care of and will check all values before the program is run. Command line arguments are used instead interactive menu based ones. | ||||||||||||||||||||||
B.12. ACD | |||||||||||||||||||||||
Q: | What is an ACD files? | ||||||||||||||||||||||
A: | Every EMBOSS and EMBASSY program has an ACD (AJAX Command Definition) file which describes the application, its options (parameters) and command line interface. The ACD file controls the behaviour of the application at the command line, particularly, all the user input operations. It includes an application definition (describing the application itself), a data definition for every application option (which describe the program parameters), attributes of the data definitions and the datatype of each option. | ||||||||||||||||||||||
B.13. Interfaces | |||||||||||||||||||||||
Q: | What types of interface are available? | ||||||||||||||||||||||
A: | The EMBOSS command line is the simplest and best supported way to launch applications. The command line behaviour is consistent across all applications and provides a simple interface to (and complete control over) them. There are also web interfaces, graphical user interfaces, workflow various other types of interface. These simplify, at least for some people, the ways to run EMBOSS applications. | ||||||||||||||||||||||
B.14. Graphics | |||||||||||||||||||||||
Q: | What Graphics options are available? | ||||||||||||||||||||||
A: | To see what graphics drivers are available type
| ||||||||||||||||||||||
Q: | Plotters and pen colours. | ||||||||||||||||||||||
A: | The hp drivers presume the pens are loaded as:
Otherwise your output will have different colours. | ||||||||||||||||||||||
Q: | Browsing the Gnu site I came across | ||||||||||||||||||||||
A: | So far they are still GPL licensed rather than LGPL. Robert Maier promised a while back to LGPL them but has not yet. A pity as it makes all the difference for linking in third party applications to EMBOSS. | ||||||||||||||||||||||
Q: | I get error messages when I try to display X11 on my PC. I am running the Hummingbird Exceed X11 emulator. | ||||||||||||||||||||||
A: | This should only affect versions of EMBOSS pre-5.0.0. The Hummingbird Exceed X11 emulator (and maybe other systems) use the 'TrueColor' display by default. You should change the configuration settings so that it uses 'PseudoColor'. In version 6.1 of Hummingbird Exceed, this is done by clicking on the Exceed section of the Windows 98 tool bar at the bottom of the screen. Select | ||||||||||||||||||||||
B.15. Internals | |||||||||||||||||||||||
Q: | Is there a maximum size for sequences? | ||||||||||||||||||||||
A: | The maximum size for any program depends only on how much memory your system has. Of course, some programs (and some program options) can take up too much memory, or simply run very slowly. You might have a constraint imposed on your usage of memory. Try using the Unix command
| ||||||||||||||||||||||
Q: | GCG has a somewhat arbitrary fragment length limit of 2500 bp for | ||||||||||||||||||||||
A: | No. The mse package has no limit, you are only limited by how much memory you have. | ||||||||||||||||||||||
Q: | I am trying to write a web interface for an emboss program and run apache. The program complains that there is no HOME directory set. | ||||||||||||||||||||||
A: | Just put these at the top after your
These two are important, but you can also pass other "constants". | ||||||||||||||||||||||
B.16. Software Development | |||||||||||||||||||||||
Q: | I am thinking of contributing software - how do I proceed? | ||||||||||||||||||||||
A: | Mail the EMBOSS developers at emboss-bug@emboss.open-bio.org |