Révision c25275e2 doc/sphinx_doc/tuto.rst

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.

Formats disponibles : Unified diff