X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fdoc%2FbbtkWebSite%2Finstall.html;h=76aea2913302f3a6c2fb96f05ed0bbc0e440df9f;hb=3928b4ad06b5b5fd142f696f58a7828d064e2883;hp=b2199402557518fbd761d83b50a5bedd68af461b;hpb=84938d0064ff835af0f2dfb4bc4131a57e66dc1b;p=bbtk.git diff --git a/kernel/doc/bbtkWebSite/install.html b/kernel/doc/bbtkWebSite/install.html index b219940..76aea29 100644 --- a/kernel/doc/bbtkWebSite/install.html +++ b/kernel/doc/bbtkWebSite/install.html @@ -3,12 +3,11 @@ - Install + BBTK @BBTK_VERSION@ Install -
-
-
Install
+
BBTK @BBTK_VERSION@ +(@BBTK_VERSION_DATE@) build instructions
    @@ -36,61 +35,27 @@ style="font-weight: normal;">Requirements
    • cmake >= 2.4.6
      • - +
    • wxWidgets  >=   +2.6.3 
    • optional :
        • -
      • wxWidgets  >=   -2.6.3
        -
        • -
          -
        • yum install wxGTK-devel -(fedora extras repos)
          -
          • -
      • LaTeX -to generate the pdf doc
        +to generate the pdf guides
        • -
      • tth to generate the html doc
        • - +
      • tth to generate the html +guides
        +
      • itk to compile packages itk, itkvtk
        • -
          -
        • yum install -InsightToolkit-devel (creatis repos)
          -
          • -
      • vtk to compile package vtk, wxvtk
        • +
      • doxygen to build the sources +documentation
        • +
      • graphviz/dot to generate the +packages doc with pipeline graphs
        +
          • -
        • yum Install vtk-devel -(fedora extras repos)
          • -
        • Patches needed:
          • -
            -
          • problem with -/usr/lib/vtk-5.0/VTKConfig.cmake : had -to change line 9: SET(VTK_INSTALL_PREFIX "${VTK_DIR}") by -SET(VTK_INSTALL_PREFIX "") to be compatible with -CMake/Modules/FindVTK.cmake
            • -
          • add /usr/local/lib in /etc/ld.so.conf or -set LD_LIBRARY_PATH
            • -
    @@ -99,6 +64,7 @@ set LD_LIBRARY_PATH style="font-weight: normal;">Known working configurations   - gcc:
    +        4.3.0 (Fedora Core 9)
            @@ -168,22 +134,46 @@ set LD_LIBRARY_PATH style="font-weight: normal;">Install from sources     Uncompress the -archive or checkout the source from the cvs repository (see Download page).
    +archive or checkout the source from the cvs repository
        In the parent folder of the bbtk sources type :
        > mkdir bbtkbin; cd bbtkbin
        > ccmake ../bbtk
        Check the desired options. See CMake build options for a description.
    -    Type 'c' many -times then 'g'.
    + style="font-style: italic;"> for a description.
    +
    +    ==> +IMPORTANT NOTE :
    +
    +        +Type 'c' many +times until no area is flagged with a '*' and three times more +then type 'g', to generate.
        > make
        > sudo make install
       Enjoy !

     +

    Uninstall
    +

    +    You can run bbtk-uninstall.sh +as root.
    +    WARNING :
    +       This is a brute force **UNSAFE** +uninstaller which removes all files and folders starting with 'bb' in :
    +        INSTALL-PREFIX/bin
    +        INSTALL-PREFIX/lib
    +        INSTALL-PREFIX/include
    +        INSTALL-PREFIX/share/bbtk
    +    However it lists the files found and prompts you +before proceeding...
    +
    +

    Windows

    @@ -193,53 +183,39 @@ times then 'g'.
    style="font-weight: normal;">Requirements

    Mandatory

      -
    • .net
      +
    • .net V7 to +compile the kernel and the packages
      • -
    • CMake -2.4 patch 6CMake +2.4 patch 6 to -generate the project file for .net
      -
      • +generate the project file for .net +
    • wxWidgets-2.8.5  +to +build graphical interface boxes

    Optional

      -
    • TortoiseVCS (Direct CVS -tool within Explorer) and Putty (Telnet -and SSH client) to get the sources from the cvs module
      • -
    • wxWidgets-2.8.5 (sources) to -build graphical interface boxes
      -
      • -
    • VTK -5.0.3 source (VTK 5.0.3 source code) to build vtk boxes (and if you -want :  VTK -5.0.3 data (VTK 5.0.3 data folder) and VTK -5.0.3 documentation (VTK 5.0.3 html documentation))
      • -
    • InsightToolkit-3.4.0 +
    • VTK +5.0.3 source  to build vtk boxes 
      • +
    • InsightToolkit-3.4.0 to build itk boxes
      • -
    • Miktex (TeX compiler +
    • Miktex +(TeX compiler and TeX-Pdf translation tool) to build documentations
      • -
    • TTH (TeX to HTML translation +
    • TTH (TeX +to HTML translation tool) to build html documentations
      • -
    • Doxygen to build the +
    • Doxygen +to build the code documentations
      • -
    • Graphviz to generate the -graphs in doxygen doc and black box pipelines graphs   +
    • Graphviz +to generate the +graphs in doxygen doc and black box pipelines graphs 
    @@ -247,8 +223,7 @@ graphs in doxygen doc and black box pipelines graphsKnown working configurations
      -
    • .net -????
      +
    • .net V7
    • cmake
      • @@ -281,106 +256,20 @@ patch 6      Steps
       -
        -
      • Download -the required files listed before.
        • -
      -
        -
      • CMAKE -2.4.6
        • -
      - 1. -Uninstall previous versions of CMake (if any)
      -      2. -Double clic on the installation file cmake-2.4.6-win32-x86.exe
      -       -
        -
      • Install -VTK 5.0.3
        • -
      - 1. -Decompress in C:\Creatis\VTK5.0.3, each one in a separate -folder, the -files
      -         -- vtkdata-5.0.3.tar.gz
      -   - vtkDocHtml-5.0.3.tar.gz
      -   - basic-miktex-2.6.2742.exe.
      -      2. -Create the project of VTK5.0.3 in CMake with:
      -         -- Binary folder C:\Creatis\VTK5.0.3Bin
      -         -- Configuration:
      -           -BUILD_SHARED_LIBS --> ON
      -           -If you want to compile the examples set: BUILD_EXAMPLES  --> ON
      -         -- Check that the VTK_DATA_ROOT variable at CMake is -C:\Creatis\VTK5.0.3\VTKData
      -         -- Clic configure once again and create (ok) the project
      -      3. -Open -the created VTK project at C:\Creatis\VTK5.0.3Bin\VTK.sln and build the -entire solution
      -       -
        -
      • TTH : Decompress the file tth_exe.zip - in -C:\Creatis\tth_exe
        -
        • -
      - -
        -
      • MikTeX : Double clic on the installation file -basic-miktex-2.6.2742.exe (it is -not necessary to change the default installation path)
        -
        • -
      - -
        -
      • BBTK
        • -
        • Uncompress -the sources in C:\Creatis\bbtk or checkout the source from the cvs (see Download -page).
          • +the sources in yourSourceDirectory +or checkout the source from the cvs 
        • Create the build folder C:\Creatis\bbtkBinyourSourceDirectory\bin
          • -
        • Drag and drop the file -C:\Creatis\bbtk\CMakeLists.txt on the CMakeSetup iconDrag and drop the file yourSourceDirectory\CMakeLists.txt on the CMakeSetup icon
            • @@ -389,63 +278,37 @@ C:\Creatis\bbtk\CMakeLists.txt on the CMakeSetup iconCheck the desired options for the build. See CMake build options for a description. -
          • If -you want to build with vtk : for a description
            • +

          • +
            • +
          +
        • To build with WxWidgets : the .ddl +must be accessible; either their names are in system PATH variable, +either copy +them in the current bin directory (bin/Debug or bin/Release, depending +whether you compiled in Debug or Release mode)
          • -
            -
          • Enable -Show Advanced Values
            • -
          • Clic -configure twice and check that the VTK_DIR variable at CMake -is C:/Creatis/VTK5.0.3Bin
            • -
          • Clic -configure one more time
            • -
          -
        • If -you want to build with itk :
          • -
            -
          • Enable -Show Advanced Values
            • -
          -
            -
          • Clic -configure twice and check that the ITK_DIR variable at CMake -is C:/Creatis/InsightToolkitBin
            • -
          -
            -
          • Clic -configure one more time
            • -
          -
        • Clic -configure many times and create the project (click ok).
          • -
      • To build with WxWidgets : Copy -the debug dll files like wxbase26d_<LIBRARY_NAME>*.dll from -wxWidgets to the bbtk binaries directory.  Example : copy C:\Creatis\wxWidgets-2.6.3\wxWidgets-2.6.3\lib\vc_dll - to: C:\Creatis\bbtkBin\bin\debugTo build with VTK : the .ddl must be accessible; either their +names are in system PATH variable, either copy +them in the current bin directory (bin/Debug or bin/Release, depending +whether you compiled in Debug or Release mode)
      • To build with VTK : Copy -all the debug dll files from VTK5.0.3 to the bbtk binaries directory. -Example : copy all files in -C:\Creatis\VTK5.0.3Bin\bin\debug to: C:\Creatis\bbtkBin\bin\debug
        • -
      • To -build with ITK : ...To +build with ITK :  the .ddl must be accessible; either their +names are in system PATH variable, either copy +them in the current bin directory (bin/Debug or bin/Release, depending +whether you compiled in Debug or Release mode)
      • Open -the solution created by cmake : C:\Creatis\bbtkBin\BBTK.sln and build +the solution created by cmake : ourSourceDirectory\bin\BBTK.sln and build the entire solution.
        • If @@ -463,7 +326,6 @@ needs to build the BBTK documentation.
      Enjoy !
      -
@@ -481,7 +343,8 @@ indicate the dependencies on external libraries or utilities.


- +
@@ -579,7 +442,7 @@ If set will compile all bbs of folder appli of all packages using bbc
+ + + + + @@ -633,6 +505,54 @@ Requires : itk
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -789,12 +718,6 @@ Requires : itk, vtk
- - - - - @@ -845,12 +768,19 @@ Requires : wxWidgets, vtk
- - - + + + + + @@ -934,6 +864,5 @@ set to ON when wxWidgets library is needed with the choices made
Option
@@ -560,7 +423,7 @@ interpreter 		BUILD_BBS_APPLI_BINARIES
 Build executables for all bbs applications of all packages ?
-If set will compile all bbs of folder appli of all packages using bbc
+If set will compile all bbs of folder appli of all packages, using bbc
 OFF
 Build -doxygen documentation for bbtk and packages?
+doxygen documentation for bbtk kernel?
Requires doxygen
 style="vertical-align: top; background-color: rgb(192, 192, 192);">ON
BUILD_BBTK_PACKAGE_demo
+ 		Build the package 'demo' ?
+Requires : itk, vtk
+ 		OFF
+
BUILD_BBTK_PACKAGE_itk
 OFF
 BUILD_BBTK_PACKAGE_itkvtk
+ 		Build the package 'itkvtk ?
+Requires : itk, vtk
+ 		OFF
BUILD_BBTK_PACKAGE_std
+ 		Build the package 'std' ?ON
BUILD_BBTK_PACKAGE_toolsbbtk
+ 		Build the package 'toolsbbtk' ?ON
+
BUILD_BBTK_PACKAGE_vtk
+ 		Build the package 'vtk' ?
+Requires : vtk
+ 		ON
+
BUILD_BBTK_PACKAGE_wx
+ 		Build the package 'wx' ?
+Requires : wxWidgets
+ 		ON
+
BUILD_BBTK_PACKAGE_wxvtk
+ 		Build the package 'wxvtk' ?
+Requires : wxWidgets, vtk
+ 		ON
+
   @@ -773,6 +693,15 @@ itk images of type unsigned  short ?
style="vertical-align: top; background-color: rgb(204, 204, 204);">ON
BUILD_BBTK_PACKAGE_demoBuild the package 'demo' ?
+Requires : ALL the other +packages
+ 		OFF
+
BUILD_BBTK_PACKAGE_itkvtk
 OFF
BUILD_BBTK_PACKAGE_testBuild the package 'test' ?OFF
-
BUILD_BBTK_PACKAGE_toolsbbtk Build the package 'toolsbbtk' ?
GENERATE_RPMBUILD_SPEC
+ 		EXECUTABLE_OUTPUT_PATH
 Set to ON to create a .spec file to generate a rpm with -rpmbuild
+ 		Single output directory for +building all the executables
OFF
+ 		-
+
LIBRARY_OUTPUT_PATHSingle output directory for +building all the libraries-
-