Skip to content

Commit ff29057

Browse files
committed
Updated the README in the Galaxy tool XML.
1 parent f968d6f commit ff29057

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

galaxy/package_neptune/tool_dependencies.xml

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
Neptune
3030

31-
Copyright Government of Canada 2015-2016
31+
Copyright Government of Canada 2015-2017
3232

3333
Written by: Eric Marinier, Public Health Agency of Canada,
3434
National Microbiology Laboratory
@@ -62,9 +62,42 @@ probabilistic models instead of heuristic strategies.
6262

6363
**Neptune 1.2.4**
6464

65-
2016 July 11
65+
This release makes several small improvements, including: reducing the standard
66+
output clutter, adding timings to stages, and updating the documentation.
6667

67-
This release includes some installation improvements.
68+
## Requirements ##
69+
------------------
70+
71+
Neptune requires Python 2.7. You may check the installed version with the
72+
following:
73+
74+
$ python --version
75+
76+
If running a Debian distribution (ex: Ubuntu), dependencies may be installed
77+
using the following command:
78+
79+
$ sudo install/debian_dependencies.sh
80+
81+
Otherwise, the following dependencies must be installed manually:
82+
83+
- python-pip
84+
- python-virtualenv
85+
- build-essential
86+
- python-dev
87+
- NCBI BLAST+
88+
89+
## Installation ##
90+
------------------
91+
92+
It is strongly recommended you refer to the
93+
[manual](documentation/manual/Manual.pdf) for full installation instructions.
94+
Neptune may be installed using the following command:
95+
96+
$ INSTALL.sh
97+
98+
You may specify an install PREFIX location, and Neptune will install into
99+
PREFIX/lib and PREFIX/bin. This only requires security privileges if the
100+
install location requires them.
68101

69102
## Running Neptune ##
70103
---------------------
@@ -78,14 +111,13 @@ A simple example of running Neptune:
78111
$ neptune --inclusion /path/to/inclusion/ --exclusion /path/to/exclusion/
79112
--output /path/to/output/
80113

81-
Please refer to the documentation for more details.
114+
Please refer to the [manual](documentation/manual/Manual.pdf) for more details.
82115

83116
## Contact ##
84117
-------------
85118

86119
**Eric Marinier**: eric.marinier@phac-aspc.gc.ca
87120

88-
89121
</readme>
90122
</package>
91123
</tool_dependency>

0 commit comments

Comments
 (0)