Révision f78441a4 README

b/README
1
*****************************************
2
Readme / Documentation for `MyLabsStocks`
3
*****************************************
4 1

  
5
`MyLabsStocks` offers Python API and R package allowing to perform 
6
quantitative analysis of nucleosomal epigenome. It is especially well 
7
suited for scripting to extract natural Single-Nucleosome Epi-
8
Polymorphisms (SNEP) from ChIP-Seq data.
2
Readme / Documentation for *MyLabStocks*
3
****************************************
4

  
5
*MyLabStocks* is a web application allowing to easily store, share and
6
retrieve information about molecular biology materials stored in a
7
laboratory.
8

  
9 9

  
10 10
License
11 11
=======
12 12

  
13
Copyright CNRS 2012-2013                                                 
14
                                                                          
15
- Florent CHUFFART                                                         
16
- Gael YVERT                                                               
17
                                                                          
18
This software is a computer program which purpose is to perform quanti-
19
tative analysis of epigenetic marks at single nucleosome resolution.     
20
                                                                          
21
The Software is provided “as is” without warranty of any kind, either 
22
express or implied, including without lim- itation any implied warranties 
23
of condition, uninterrupted use, merchantability, fitness for a particular 
24
purpose, or non-infringement. You use this software at your own risk.
25

  
26
This software is governed by the CeCILL license under French law and     
27
abiding by the rules of distribution of free software.  You can  use,    
28
modify and/ or redistribute the software under the terms of the CeCILL   
29
license as circulated by CEA, CNRS and INRIA at the following URL        
30
"http://www.cecill.info".                                                
31
                                                                          
32
As a counterpart to the access to the source code and  rights to copy,   
33
modify and redistribute granted by the license, users are provided only  
34
with a limited warranty  and the software's author,  the holder of the   
35
economic rights,  and the successive licensors  have only  limited       
36
liability.                                                               
37
                                                                          
38
In this respect, the user's attention is drawn to the risks associated   
39
with loading,  using,  modifying and/or developing or reproducing the    
40
software by the user in light of its specific status of free software,   
41
that may mean  that it is complicated to manipulate,  and  that  also    
42
therefore means  that it is reserved for developers  and  experienced    
43
professionals having in-depth computer knowledge. Users are therefore    
44
encouraged to load and test the software's suitability as regards their  
45
requirements in conditions enabling the security of their systems and/or 
46
data to be ensured and,  more generally, to use and operate it in the    
47
same conditions as regards security.                                     
48
                                                                          
49
The fact that you are presently reading this means that you have had     
50
knowledge of the CeCILL license and that you accept its terms.           
13
Copyright CNRS 2012-2013
14

  
15
* Florent CHUFFART
16

  
17
* Gael YVERT
18

  
19
This software is a computer program which purpose is to perform
20
quantitative analysis of epigenetic marks at single nucleosome
21
resolution.
22

  
23
The Software is provided “as is” without warranty of any kind, either
24
express or implied, including without limitation any implied
25
warranties of condition, uninterrupted use, merchantability, fitness
26
for a particular purpose, or non-infringement. You use this software
27
at your own risk.
28

  
29
This software is governed by the CeCILL license under French law and
30
abiding by the rules of distribution of free software.  You can  use,
31
modify and/ or redistribute the software under the terms of the CeCILL
32
license as circulated by CEA, CNRS and INRIA at the following URL
33
"http://www.cecill.info".
34

  
35
As a counterpart to the access to the source code and  rights to copy,
36
modify and redistribute granted by the license, users are provided
37
only  with a limited warranty  and the software's author,  the holder
38
of the economic rights,  and the successive licensors  have only
39
limited liability.
40

  
41
In this respect, the user's attention is drawn to the risks associated
42
with loading,  using,  modifying and/or developing or reproducing the
43
software by the user in light of its specific status of free software,
44
that may mean  that it is complicated to manipulate,  and  that  also
45
therefore means  that it is reserved for developers  and  experienced
46
professionals having in-depth computer knowledge. Users are therefore
47
encouraged to load and test the software's suitability as regards
48
their requirements in conditions enabling the security of their
49
systems and/or data to be ensured and,  more generally, to use and
50
operate it in the same conditions as regards security.
51

  
52
The fact that you are presently reading this means that you have had
53
knowledge of the CeCILL license and that you accept its terms.
54

  
51 55

  
52 56
Installation Instructions
53 57
=========================
54 58

  
55
Links
56
-----
59
This installation has been fully tested on:
60
   * Debian 7.2.0 amd64 netinst [1], running on virtual machine using
61
     Oracle VM VirtualBox [2] for macosx (dev)
62

  
63
   * Ubuntu Server 12.04.3 LTSUbuntu server LTS [3], running on
64
     physical machine (prod)
65

  
66
[1] http://cdimage.debian.org/debian-cd/7.2.0/amd64/iso-
67
cd/debian-7.2.0-amd64-netinst.iso
68

  
69
[2] https://www.virtualbox.org
70

  
71
[3] http://www.ubuntu.com/download/server
72

  
73

  
74
Prerequisites
75
-------------
76

  
77
   sudo apt-get install git mysql-server apache2 php5 phpmyadmin php5-curl csh blast2 tomcat ant openjdk-6-jdk
78

  
79

  
80
Get MyLabStocks Sources
81
-----------------------
82

  
83
   git clone http://forge.cbp.ens-lyon.fr/git/mylabstocks
57 84

  
58
`MyLabsStocks` home page: http://www.ens-lyon.fr/LBMC/gisv/
59 85

  
60
`MyLabsStocks` documentation: http://www.ens-lyon.fr/LBMC/gisv/
86
Install wwwBlast
87
----------------
88

  
89
MyLabStocks is distributed with wwwblast working on a x64
90
architecture. For other architectures refer to the NCBI repositories h
91
ttp://mirrors.vbi.vt.edu/mirrors/ftp.ncbi.nih.gov/blast/executables/re
92
lease/LATEST
61 93

  
94
   cd mylabstocks/opts/
95
   tar xfvz wwwblast-2.2.26-x64-linux.tar.gz
96
   sudo cp -r blast /var/www/.
97
   sudo chown www-data:www-data /var/www/blast/TmpGifs /var/www/blast/*.log /var/www/blast/db/
98
   echo "<Directory /var/www/blast/>" > /tmp/blast.conf
99
   echo "   Options +ExecCGI" >> /tmp/blast.conf
100
   echo "</Directory>" >> /tmp/blast.conf
101
   echo "AddHandler cgi-script .cgi" >> /tmp/blast.conf
102
   sudo cp /tmp/blast.conf /etc/apache2/conf.d/blast.conf
103
   rm /tmp/blast.conf
104
   sudo /etc/init.d/apache2 restart
105
   sudo sed -i 's/<option VALUE.*test_na_db/<option VALUE=oligostock_db>oligostock_db<option VALUE=plasmidstock_db>plasmidstock_db<option VALUE=plfeatstock_db>plfeatstock_db/g' /var/www/blast/blast.html
106
   sudo sed -i 's/<option VALUE.*test_aa_db//g' /var/www/blast/blast.html
107
   cat /var/www/blast/blast.rc > /tmp/blast.rc
108
   echo "blastn oligostock_db" >> /tmp/blast.rc
109
   echo "tblastn oligostock_db" >> /tmp/blast.rc
110
   echo "tblastx oligostock_db" >> /tmp/blast.rc
111
   echo "blastn plasmidstock_db" >> /tmp/blast.rc
112
   echo "tblastn plasmidstock_db" >> /tmp/blast.rc
113
   echo "tblastx plasmidstock_db" >> /tmp/blast.rc
114
   echo "blastn plfeatstock_db" >> /tmp/blast.rc
115
   echo "tblastn plfeatstock_db" >> /tmp/blast.rc
116
   echo "tblastx plfeatstock_db" >> /tmp/blast.rc
117
   sudo cp /tmp/blast.rc /var/www/blast/blast.rc
118
   rm /tmp/blast.rc
119
   cd ../..
62 120

  
63
Installation
64
------------
65 121

  
66
rsync -cauvz  --exclude="formatdb.log" --exclude=".DS_Store" ../src/ root@cremone:/var/www/labstocks/
122
Install PlasMapper
123
------------------
67 124

  
68
cd /var/www/labstocks
69
# sudo vi connect_entry.php 
70
sudo touch formatdb.log
71
sudo chmod 440 connect_entry.php 
72
sudo chown -R www-data:www-data connect_entry.php formatdb.log  plasmid_files raw_dirs
125
   cd mylabstocks/opts/
126
   tar xfvz PlasMapper_download.tar.gz
127
   cd PlasMapper
128
   # modify installdir as /var/lib/tomcat6
129
   sed -i 's/\/home\/tomcat/\/var\/lib\/tomcat6/g' build.xml
130
   # modify servletjar as /usr/share/tomcat6/lib/servlet-api.jar
131
   sed -i 's/${installdir}\/common\/lib\/servlet-api.jar/\/usr\/share\/tomcat6\/lib\/servlet-api.jar/g' build.xml
132
   # change /home/tomcat for /var/lib/tomcat6
133
   sed -i 's/\/home\/tomcat/\/var\/lib\/tomcat6/g' src/ca/ualberta/xdong/plasMapper/annotate/plasMapConfiguration_en_CA.properties
134
   # and set blastallDir=/usr/bin/
135
   sed -i 's/\/usr\/local\/bin\//\/usr\/bin\//g' src/ca/ualberta/xdong/plasMapper/annotate/plasMapConfiguration_en_CA.properties
136
   # Here PlasMapper is ready to be configured
73 137

  
138
   ant clean
139
   ant build
140
   sudo ant install
141
   sudo rm -Rf /var/lib/tomcat6/webapps/PlasMapper/tmp
142
   sudo ln -s /tmp/tomcat6-tomcat6-tmp/ /var/lib/tomcat6/webapps/PlasMapper/tmp
143
   echo '<?xml version="1.0" encoding="UTF-8"?><Context path="/myapp" allowLinking="true"></Context>' > context.xml
144
   sudo mv context.xml /var/lib/tomcat6/webapps/PlasMapper/META-INF/
145
   sudo /etc/init.d/tomcat6 restart
146
   # Here PlasMapper works on your server at the url http://myserver:8080/PlasMapper
74 147

  
75
Migration
76
cd /var/www/labstocks
77
sudo cp -r ../labstocks.bck2/plasmid_files/*.gb.gz plasmid_files/.
78
sudo chmod -R a+r plasmid_files
79
sudo chown -R www-data:www-data plasmid_files
80
sudo cp -r ../labstocks.bck2/collections collections/.
81
cd raw_dirs/antibodies/
82
sudo mkdir `for ((a=1; a <= 24 ; a++)); do echo $a ; done`
83
cd ../..
84
sudo cp ../labstocks.bck2/antibody_files/10.Anti-H3K14ac\(07-353\).pdf                raw_dirs/antibodies/10/Anti-H3K14ac\(07-353\).pdf                            
85
sudo cp ../labstocks.bck2/antibody_files/11.Anti-H3ac\(06-599\).pdf                   raw_dirs/antibodies/11/Anti-H3ac\(06-599\).pdf                               
86
sudo cp ../labstocks.bck2/antibody_files/12.Anti-H3\(ab1791\).pdf                     raw_dirs/antibodies/12/Anti-H3\(ab1791\).pdf                                 
87
sudo cp ../labstocks.bck2/antibody_files/13.Anti-FLAG\(F7425\).pdf                    raw_dirs/antibodies/13/Anti-FLAG\(F7425\).pdf                                
88
sudo cp ../labstocks.bck2/antibody_files/14.Cre-Recombinase\(PRB-106C\).pdf           raw_dirs/antibodies/14/Cre-Recombinase\(PRB-106C\).pdf                        
89
sudo cp ../labstocks.bck2/antibody_files/15.GAPDH-HRP\(ab85760\).pdf                  raw_dirs/antibodies/15/GAPDH-HRP\(ab85760\).pdf                              
90
sudo cp ../labstocks.bck2/antibody_files/16.Anti-H3K9ac\(ab10812\).pdf                raw_dirs/antibodies/16/Anti-H3K9ac\(ab10812\).pdf                            
91
sudo cp ../labstocks.bck2/antibody_files/17.Anti-H3K4me3\(CS-003-100\).pdf            raw_dirs/antibodies/17/Anti-H3K4me3\(CS-003-100\).pdf                         
92
sudo cp ../labstocks.bck2/antibody_files/18.Anti-H3\(ab1791\).pdf                     raw_dirs/antibodies/18/Anti-H3\(ab1791\).pdf                                 
93
sudo cp ../labstocks.bck2/antibody_files/19.Anti-H3K4me1\(07-436\).pdf                raw_dirs/antibodies/19/Anti-H3K4me1\(07-436\).pdf                            
94
sudo cp ../labstocks.bck2/antibody_files/1.Anti-Actin-C4\(69100\).pdf                 raw_dirs/antibodies/1/Anti-Actin-C4\(69100\).pdf                             
95
sudo cp ../labstocks.bck2/antibody_files/20.Anti-H3K14ac\(07-353\).pdf                raw_dirs/antibodies/20/Anti-H3K14ac\(07-353\).pdf                            
96
sudo cp ../labstocks.bck2/antibody_files/21.Anti-H4K12ac\(07-595\).pdf                raw_dirs/antibodies/21/Anti-H4K12ac\(07-595\).pdf                            
97
sudo cp ../labstocks.bck2/antibody_files/22.Anti-Htz1\(39647\).pdf                    raw_dirs/antibodies/22/Anti-Htz1\(39647\).pdf                                
98
sudo cp ../labstocks.bck2/antibody_files/23.Anti-H2AFZ\(ab4626\).pdf                  raw_dirs/antibodies/23/Anti-H2AFZ\(ab4626\).pdf                              
99
sudo cp ../labstocks.bck2/antibody_files/24.Anti-LexA-DBD\(39185\).pdf                raw_dirs/antibodies/24/Anti-LexA-DBD\(39185\).pdf                            
100
sudo cp ../labstocks.bck2/antibody_files/2.Anti-Myc\(06-340\).pdf                     raw_dirs/antibodies/2/Anti-Myc\(06-340\).pdf                                 
101
sudo cp ../labstocks.bck2/antibody_files/3.Anti-H3\(ab10799\).pdf                     raw_dirs/antibodies/3/Anti-H3\(ab10799\).pdf                                 
102
sudo cp ../labstocks.bck2/antibody_files/4.Anti-H3\(ab24834\).pdf                     raw_dirs/antibodies/4/Anti-H3\(ab24834\).pdf                                 
103
sudo cp ../labstocks.bck2/antibody_files/5.Anti-H3K4me2\(ab7766\).pdf                 raw_dirs/antibodies/5/Anti-H3K4me2\(ab7766\).pdf                             
104
sudo cp ../labstocks.bck2/antibody_files/6.Anti-H3K4me3\(ab8580\).pdf                 raw_dirs/antibodies/6/Anti-H3K4me3\(ab8580\).pdf                             
105
sudo cp ../labstocks.bck2/antibody_files/7.Anti-H3K27me3\(07-449\).pdf                raw_dirs/antibodies/7/Anti-H3K27me3\(07-449\).pdf                            
106
sudo cp ../labstocks.bck2/antibody_files/8.Anti-H4K12ac\(06-761\).pdf                 raw_dirs/antibodies/8/Anti-H4K12ac\(06-761\).pdf                             
107
sudo cp ../labstocks.bck2/antibody_files/9.Beta-Actin-AC74\(A2228\).pdf               raw_dirs/antibodies/9/Beta-Actin-AC74\(A2228\).pdf                           
108
sudo chmod -R a+r raw_dirs
109
sudo chown -R www-data:www-data raw_dirs
110
# upload gene_synthesis_reports_pGY247.zip and gene_synthesis_reports_pGY248.zip
148
   sudo chown root:www-data /var/lib/tomcat6/webapps/PlasMapper/dataBase/db_vectorFeature/*.*
149
   sudo chmod 664 /var/lib/tomcat6/webapps/PlasMapper/dataBase/db_vectorFeature/*.*
150
   sudo chown root:www-data /var/lib/tomcat6/webapps/PlasMapper/dataBase/db_vectorFeature/
151
   sudo chmod 775 /var/lib/tomcat6/webapps/PlasMapper/dataBase/db_vectorFeature/
152
   sudo chown root:www-data /var/lib/tomcat6/webapps/PlasMapper/html/feature.html
153
   sudo chmod 664 /var/lib/tomcat6/webapps/PlasMapper/html/feature.html
154
   # Here plasmids feature could be blasted by MyLabStock
111 155

  
156
   cd ../../..
112 157

  
113 158

  
159
Install MyLabStocks
160
-------------------
114 161

  
162
   sudo cp -r mylabstocks/src /var/www/labstocks
163
   sudo rm /var/www/labstocks/
164
   sudo touch /var/www/labstocks/formatdb.log
165
   sudo chmod 440 /var/www/labstocks/connect_entry.php
166
   sudo mkdir /var/www/labstocks/plasmid_files
167
   sudo mkdir /var/www/labstocks/raw_dirs
168
   sudo mkdir /var/www/labstocks/collections
169
   sudo chown -R www-data:www-data /var/www/labstocks/connect_entry.php /var/www/labstocks/formatdb.log  /var/www/labstocks/plasmid_files /var/www/labstocks/raw_dirs
115 170

  
116
scp -r stainer:Desktop/LBMC/projects/plasmapper/src/plasmid_files labstocks
117
vi labstocks/connect_entry.php
118
sudo cp -r labstocks /var/www/
119
sudo chmod 440 /var/www/labstocks/connect_entry.php 
120
sudo chown www-data:www-data /var/www/labstocks/connect_entry.php
121
sudo chown -R www-data:www-data /var/www/labstocks/plasmid_files
122
sudo chown -R www-data:www-data /var/www/labstocks/raw_dirs
123
sudo touch /var/www/labstocks/formatdb.log
124
sudo chown www-data:www-data /var/www/labstocks/formatdb.log
171

  
172
Configurate MyLabStocks
173
-----------------------
174

  
175
Now you have to update connexion params in
176
/var/www/labstocks/connect_entry.php
177

  
178
   sudo vi /var/www/labstocks/connect_entry.php
179

  
180
finally run the following script to  define passwords and instantiate
181
db.
182

  
183
   php mylabstocks/src/install_db.phpsh
184

  
185
Congratulation your LabStocks instance is available on the url
186
http://your_server/labstocks.
125 187

  
126 188

  
189
Links
190
-----
127 191

  
192
*MyLabStocks* home, repository and documentation: http://forge.cbp
193
.ens-lyon.fr/redmine/projects/mylabstocks
128 194

  
195
Gael Yvert lab: http://www.ens-lyon.fr/LBMC/gisv/
129 196

  
130 197

  
131 198
Usage
132 199
=====
133 200

  
134
In the strain section, the form `Search in genotype` filters strains where the 
135
fields `locus1`, `locus2`, `locus3`, `locus4`, `locus5`, `ADE2`, `HIS3`, `LEU2`, 
136
`LYS2`, `MET15`, `TRP1`, `URA3`, `HO_`, `Cytoplasmic_Character` or 
137
`extrachromosomal_plasmid` contain the given expression. This filter is case 
138
insensitive.
139

  
140
Even in edit mode, users are not granted permission to directly edit a plasmid 
141
sequence, nor the URL to the plasmid sequence file. If a new sequence must be 
142
entered instead of the current one, users must upload a new sequence file, in 
143
.gb or .gb.gz format. MyLabStocks then automatically reads the file and update 
144
the sequence field and the URL. This ensures consistency between URL, sequence 
145
and the file itself.
146

  
147
TODO
148
====
149

  
150
  - Upload a .gb file, gzip it on fly for plasmids.
151
  - Bug with plasmid 246, having a look on log file: tail -f /var/log/tomcat6/catalina.out
152
  - Add persistence on advanced search form conditions.
153
  - Remove file field for antibodies
154
  - More error msg when an uploaded file is too big. (>2Mo).
201

  
202
Advanced Search
203
---------------
204

  
205
In the strain section, the form *Search in genotype* filters strains
206
where the fields *locus1*, *locus2*, *locus3*, *locus4*, *locus5*,
207
*ADE2*, *HIS3*, *LEU2*, *LYS2*, *MET15*, *TRP1*, *URA3*, *HO_*,
208
*Cytoplasmic_Character* or *extrachromosomal_plasmid* contain the
209
given expression. This filter is case insensitive.
210

  
211

  
212
Plasmids Sequences Management
213
-----------------------------
214

  
215
Even in edit mode, users are not granted permission to directly edit a
216
plasmid sequence, nor the URL to the plasmid sequence file. If a new
217
sequence must be entered instead of the current one, users must upload
218
a new sequence file, in .gb or .gb.gz format. MyLabStocks then
219
automatically reads the file and update the sequence field and the
220
URL. This ensures consistency between URL, sequence and the file
221
itself.

Formats disponibles : Unified diff