annotate README.md @ 5:08bb52273ae1

Bjoern: remove unused repository dependency, cleanups
author Jim Johnson <jj@umn.edu>
date Mon, 17 Feb 2014 08:13:33 -0600
parents 10f4a0356342
children d2c61663e33c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
1 # msconvert
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
2
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
3 This repository contains Galaxy tool wrappers for msconvert, part of
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
4 the ProteoWizard (http://proteowizard.sourceforge.net/) package.
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
5
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
6 # Installing
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
7
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
8 Due to potential difficulties installing ProteoWizard with vendor
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
9 library support, tools for interacting with vendor types are seperated
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
10 out into their own wrappers. Galaxy is generally deployed under Linux,
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
11 but vendor support in ProteoWizard requires .NET 4.0. There are at
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
12 least two ways to get this to work:
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
13
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
14 * Galaxy jobs may be configured to submit to a Windows host with
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
15 ProteoWizard installed using the
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
16 LWR. http://wiki.g2.bx.psu.edu/Admin/Config/LWR
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
17
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
18 * ProteoWizard can be installed under Wine. Guidance on how to set
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
19 this up and package such environments for cloud deployments can be
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
20 found here: https://github.com/jmchilton/proteomics-wine-env
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
21
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
22 Wrappers for both msconvert version 2 and version 3+ are provided
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
23 because version 3+ of msconvert with vendor library support requires
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
24 .NET 4.0 and this may difficult or impossible under Wine in Linux with
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
25 all but the most recent versions of Wine (1.4+).
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
26 # Obtaining Tools
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
27
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
28 Repositories for all Galaxy-P tools can be found at
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
29 https:/bitbucket.org/galaxyp/.
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
30
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
31 # Contact
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
32
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
33 Please send suggestions for improvements and bug reports to
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
34 jmchilton@gmail.com.
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
35
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
36 # License
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
37
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
38 All Galaxy-P tools are licensed under the Apache License Version 2.0
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
39 unless otherwise documented.
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
40
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
41 # Tool Versioning
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
42
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
43 Galaxy-P tools will have versions of the form X.Y.Z. Versions
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
44 differing only after the second decimal should be completely
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
45 compatible with each other. Breaking changes should result in an
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
46 increment of the number before and/or after the first decimal. All
10f4a0356342 Uploaded
galaxyp
parents:
diff changeset
47 tools of version less than 1.0.0 should be considered beta.