annotate README.txt @ 3:78afd7f439f3 draft default tip

master branch Updating with tag :CI_COMMIT_TAG - - Fxx
author fgiacomoni
date Wed, 15 Feb 2023 15:57:49 +0000
parents 86296c048e46
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
1 ## ****** HR2 environnemnt : ****** ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
2 # version sept 2014 M Landi / A LIEURADE, Cl LIONNET, P MARIJON, B RADISSON and L VARRAILHON / F Giacomoni
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
3
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
4 ## --- PERL compilator / libraries : --- ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
5 $ perl -v
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
6 This is perl, v5.10.1 (*) built for x86_64-linux-thread-multi
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
7
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
8 # libs CORE PERL :
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
9 use strict ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
10 use warnings ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
11 use Carp qw (cluck croak carp) ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
12 use Data::Dumper ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
13 use Getopt::Long ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
14 use FindBin ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
15
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
16 # libs CPAN PERL :
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
17 $ perl -e 'use Text::CSV'
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
18 $ sudo perl -MCPAN -e shell
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
19 cpan> install Text::CSV
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
20
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
21 # libs pfem PERL : already include in the package
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
22 use lib::conf qw( :ALL ) ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
23 use lib::csv qw( :ALL ) ;
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
24 --
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
25
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
26 ## --- R bin and Packages : --- ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
27 NA
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
28 --
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
29
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
30 ## --- Binary dependencies --- ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
31 Install folowing binaries :
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
32 * HR2 :
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
33 source : HR2_v1.04.cpp available in the tar ball at lib/HR2_v1.04.cpp
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
34 lab : http://jhau.maliwi.de/sci/ms.html for initial project and http://fiehnlab.ucdavis.edu/projects/Seven_Golden_Rules/Software/ for fork
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
35 install : in /opt/prog/metabolomics/hr2 (you can change this path in conf file : conf_hr2.cfg
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
36 compilation : g++ HR2_v1.04.cpp -o HR2-all-res_v1.04.exe
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
37
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
38 The project is available on :
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
39 http://fiehnlab.ucdavis.edu/projects/Seven_Golden_Rules/Software/seven-golden-rules-supplement-v46.zip (the launch of the download may take some time)
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
40 ~/seven-golden-rules-supplement-v46.zip/supplement/HR2-formula-generator/HR2.zip/HR2.cpp
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
41 OR
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
42 http://sourceforge.net/projects/hires/ : This proposed binary is an fork of the HiRes initial project.
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
43 --
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
44
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
45 ## --- Config : --- ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
46 Edit the following lines in the config file : conf_hr2.cfg
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
47 lancerHR2=/your_hr2_binary_path/HR2-all-res_v1.04.exe
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
48 JS_GALAXY_PATH=http://YOUR_GALAXY_HOSTNAME/static/scripts/libs/outputs
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
49 CSS_GALAXY_PATH=http://YOUR_GALAXY_HOSTNAME/static/style
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
50 --
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
51
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
52 ## --- XML HELP PART --- ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
53 one image : in the static/images dir
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
54 hr2.png
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
55 --
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
56
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
57 ## --- DATASETS --- ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
58 No data set ! waiting for galaxy pages
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
59 --
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
60
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
61 ## --- ??? COMMENTS ??? --- ##
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
62 In the PFEM version, the HR2 source (HR2_v*.cpp) is modified to correct atom exact masses.
86296c048e46 Init repository for [hr2]
fgiacomoni
parents:
diff changeset
63 For more information, please contact us.