Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Now that we have releases, the installation instructions should mention them.
- Loading branch information
Showing
2 changed files
with
52 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,35 @@ | ||
# Install | ||
|
||
GMGC-mapper runs on Python 3.6-3.8 and requires | ||
[prodigal](https://github.com/hyattpd/Prodigal). You need to install prodigal | ||
first and add it into your system path. | ||
[prodigal](https://github.com/hyattpd/Prodigal) to be available for genome | ||
mode. | ||
|
||
### Installing from source | ||
## Conda install | ||
|
||
The easiest way to install GMGC-mapper is through bioconda, which will ensure | ||
all dependencies (including `prodigal`) are installed automatically: | ||
|
||
```bash | ||
python setup.py install | ||
conda install -c bioconda gmgc-mapper | ||
``` | ||
|
||
## pip install | ||
|
||
Alternatively, `GMGC-mapper` is available from PyPI, so can be installed | ||
through pip: | ||
|
||
```bash | ||
pip install GMGC-mapper | ||
``` | ||
|
||
Note that this does not install `prodigal` (which is necessary for the | ||
genome-based workflow). | ||
|
||
## Install from source | ||
|
||
Finally, especially if you are retrieving the cutting edge version from Github, | ||
you can install with the standard | ||
|
||
```bash | ||
python setup.py install | ||
``` |