Révision c25275e2

b/README
826 826
APPENDICE: Generate .c2c Files
827 827
==============================
828 828

  
829
$$$ TODO make it works properly. working directory.
830

  
831 829
The *.c2c* files is a simple table that describes how the genome
832
sequence can be aligned. We generate it using NucleoMiner 1.0.
830
sequence can be aligned. We generate it using some NucleoMiner 1.0
831
scripts.
833 832

  
834
To install NucleoMiner 1.0 on your UNIX/LINUX computer you need first
835
to install the Genetic Data analysis Library (GDL), which is a dynamic
836
library of useful C functions derived from the GNU Scientific Library.
833
To use NucleoMiner 1.0 scripts on your UNIX/LINUX computer you need
834
first to install MUMmer which is a system for rapidly aligning entire
835
genomes, whether in complete or draft form.
837 836

  
838 837

  
839
Installing the GDL library
840
--------------------------
838
Installing the MUMmer library
839
-----------------------------
841 840

  
842
Get the gdl-1.0.tar.gz archive on your computer (in the directory deps
843
of your working directory). Copy it in a dedicated directory. Go into
844
this directory using the cd command, and then unfold the archive by
845
typing:
841
Get the last version of MUMmer archive on your computer
842
(MUMmer3.23.tar.gz distributed in the directory deps of your working
843
directory). Copy it in a dedicated directory. Install it locally into
844
the src folder of you working directory by typing (working directory):
846 845

  
847 846
tar -xvzf gdl-1.0.tar.gz
848 847

  
849 848
This creates a directory called gdl-1.0. You now need to go into this
850 849
directory and compile the library, by typing:
851 850

  
852
   mkdir tmp_c2c_workdir
853
   cd tmp_c2c_workdir
854
   cp ../deps/gdl-1.0.tar.gz .
855
   tar -xvzf gdl-1.0.tar.gz
856
   cd gdl-1.0
857
   ./configure
858
   make
859

  
860
   cd ..
861

  
862
Now you need to install the library on your system. This needs root
863
priviledges:
851
   cd src
852
   tar xfvz ../deps/MUMmer3.23.tar.gz
853
   cd MUMmer3.23
854
   make check
855
   make install
864 856

  
865
   sudo make install
866 857

  
858
Installing NucleoMiner 1.0 scripts
859
----------------------------------
867 860

  
868
Installing NucleoMiner 1.0
869
--------------------------
870

  
871
Get the nucleominer-1.0.tar.gz archive on your computer. Copy it in a
872
dedicated directory. Go into this directory using the cd command, and
873
then unfold the archive by typing:
874

  
875
This creates a directory called nucleominer-1.0. You now need to go
876
into this directory and compile the library, by typing:
877

  
878
   cp ../deps/nucleominer-1.0.tar.gz .
879
   tar -xvzf nucleominer-1.0.tar.gz
880
   cd nucleominer-1.0
881
   ln -s ../gdl-1.0/gdl
882
   ./configure
883
   make
861
Get the nucleominer-1.0.tar.gz archive on your computer (distributed
862
in the directory deps of your working directory). Install it locally
863
into the src folder of you working directory by typing (working
864
directory):
884 865

  
885
You can then use the binaries dircetly from this folder (best then is
886
to add the path to this folder in your PATH environment variable). If
887
you want to install nucleominer at the system's level (useful if
888
mutiple users will need it) then type, with root priviledges:
866
   cd src
867
   tar xfvz ../deps/nucleominer-1.0.tar.gz
868
   cd ..
889 869

  
890
   sudo make install
870
This creates a directory called that contains  NucleoMiner 1.0 scripts
871
(src/nucleominer-1.0/scripts).
891 872

  
892 873

  
893 874
Generate .c2c Files
......
896 877
To generate .c2c files you need to type the following command in a
897 878
terminal:
898 879

  
899
   mkdir dir_4_c2c
900
   NMgxcomp ../data/saccharomyces_cerevisiae_BY_S288c_chromosomes.fasta\
901
            ../data/saccharomyces_cerevisiae_rm11-1a_1_supercontigs.fasta\
902
            dir_4_c2c/BY_RM 2>dir_4_c2c/BY_RM.log
880
   export PATH=$PATH:src/MUMmer3.23:src/nucleominer-1.0/scripts
881
   export PERL5LIB=$PERL5LIB:src/nucleominer-1.0/scripts/
882
   NMgxcomp data/saccharomyces_cerevisiae_BY_S288c_chromosomes.fasta \
883
     data/saccharomyces_cerevisiae_rm11-1a_1_supercontigs.fasta \
884
     data/byxrm 2>NMgxcomp.log
903 885

  
904
After execution, the directory *dir_4_c2c* will hold the .c2c files.
886
After execution, the directory *data* will hold the .c2c files.
b/doc/sphinx_doc/conf.py
50 50
# built documents.
51 51
#
52 52
# The short X.Y version.
53
version = '2.3.49'
53
version = '2.3.50'
54 54
# The full version, including alpha/beta/rc tags.
55
release = '2.3.49'
55
release = '2.3.50'
56 56

  
57 57
# The language for content autogenerated by Sphinx. Refer to documentation
58 58
# for a list of supported languages.
b/doc/sphinx_doc/rref.rst
1256 1256
+---------------+---------------------------------------------------+
1257 1257
| Author:       | Florent Chuffart                                  |
1258 1258
+---------------+---------------------------------------------------+
1259
| Version:      | 2.3.49                                            |
1259
| Version:      | 2.3.50                                            |
1260 1260
+---------------+---------------------------------------------------+
1261 1261
| License:      | CeCILL                                            |
1262 1262
+---------------+---------------------------------------------------+
b/doc/sphinx_doc/tuto.rst
636 636
APPENDICE: Generate .c2c Files
637 637
------------------------------
638 638

  
639
$$$ TODO make it works properly.
640
working directory.
641 639

  
640
The `.c2c` files is a simple table that describes how the genome sequence can be aligned. We generate it using some NucleoMiner 1.0 scripts.
642 641

  
643
The `.c2c` files is a simple table that describes how the genome sequence can be aligned. We generate it using NucleoMiner 1.0.
642
To use NucleoMiner 1.0 scripts on your UNIX/LINUX computer you need first to install MUMmer which is a system for rapidly aligning entire genomes, whether in complete or draft form.
644 643

  
645
To install NucleoMiner 1.0 on your UNIX/LINUX computer you need first to install the Genetic Data analysis Library (GDL), which is a dynamic library of useful C functions derived from the GNU Scientific Library.
646

  
647
Installing the GDL library
648
^^^^^^^^^^^^^^^^^^^^^^^^^^
644
Installing the MUMmer library
645
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
649 646

  
650
Get the gdl-1.0.tar.gz archive on your computer (in the directory deps of your working directory). Copy it in a dedicated directory. Go into this directory using the cd command, and then unfold the archive by typing:
647
Get the last version of MUMmer archive on your computer (MUMmer3.23.tar.gz distributed in the directory deps of your working directory). Copy it in a dedicated directory. Install it locally into the src folder of you working directory by typing (working directory):
651 648

  
652 649
tar -xvzf gdl-1.0.tar.gz
653 650

  
......
655 652

  
656 653
.. code:: bash
657 654

  
658
  mkdir tmp_c2c_workdir
659
  cd tmp_c2c_workdir
660
  cp ../deps/gdl-1.0.tar.gz .
661
  tar -xvzf gdl-1.0.tar.gz
662
  cd gdl-1.0
663
  ./configure
664
  make
665
  
666
  cd ..
667
  
668

  
669
Now you need to install the library on your system. This needs root priviledges:
655
  cd src 
656
  tar xfvz ../deps/MUMmer3.23.tar.gz
657
  cd MUMmer3.23
658
  make check
659
  make install
670 660

  
671
.. code:: bash
672

  
673
  sudo make install
674

  
675
Installing NucleoMiner 1.0
676
^^^^^^^^^^^^^^^^^^^^^^^^^^
661
Installing NucleoMiner 1.0 scripts
662
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
677 663

  
678
Get the nucleominer-1.0.tar.gz archive on your computer. Copy it in a dedicated directory. Go into this directory using the cd command, and then unfold the archive by typing:
664
Get the nucleominer-1.0.tar.gz archive on your computer (distributed in the directory deps of your working directory). Install it locally into the src folder of you working directory by typing (working directory):
679 665

  
680
This creates a directory called nucleominer-1.0. You now need to go into this directory and compile the library, by typing:
681 666

  
682 667
.. code:: bash
683 668

  
684
  cp ../deps/nucleominer-1.0.tar.gz .
685
  tar -xvzf nucleominer-1.0.tar.gz
686
  cd nucleominer-1.0
687
  ln -s ../gdl-1.0/gdl
688
  ./configure
689
  make
690

  
691
You can then use the binaries dircetly from this folder (best then is to add the path to this folder in your PATH environment variable). If you want to install nucleominer at the system's level (useful if mutiple users will need it) then type, with root priviledges:
669
  cd src 
670
  tar xfvz ../deps/nucleominer-1.0.tar.gz 
671
  cd ..
692 672

  
693
.. code:: bash
673
This creates a directory called that contains  NucleoMiner 1.0 scripts (src/nucleominer-1.0/scripts). 
694 674

  
695
  sudo make install
696 675

  
697 676
Generate .c2c Files
698 677
^^^^^^^^^^^^^^^^^^^
......
701 680

  
702 681
.. code:: bash
703 682

  
704
  mkdir dir_4_c2c
705
  NMgxcomp ../data/saccharomyces_cerevisiae_BY_S288c_chromosomes.fasta\
706
           ../data/saccharomyces_cerevisiae_rm11-1a_1_supercontigs.fasta\
707
           dir_4_c2c/BY_RM 2>dir_4_c2c/BY_RM.log
683
  export PATH=$PATH:src/MUMmer3.23:src/nucleominer-1.0/scripts
684
  export PERL5LIB=$PERL5LIB:src/nucleominer-1.0/scripts/
685
  NMgxcomp data/saccharomyces_cerevisiae_BY_S288c_chromosomes.fasta \
686
    data/saccharomyces_cerevisiae_rm11-1a_1_supercontigs.fasta \
687
    data/byxrm 2>NMgxcomp.log
708 688
            
709
After execution, the directory `dir_4_c2c` will hold the .c2c files.
689
After execution, the directory `data` will hold the .c2c files.
b/src/DESCRIPTION
1 1
Package: nucleominer
2 2
Maintainer: Florent Chuffart <florent.chuffart@ens-lyon.fr>
3 3
Author: Florent Chuffart
4
Version: 2.3.49
4
Version: 2.3.50
5 5
License: CeCILL 
6 6
Title: nm
7 7
Depends: seqinr, plotrix, DESeq, cachecache, dplyr

Formats disponibles : Unified diff