From: jean-pierre roux Date: Tue, 21 Oct 2008 12:32:58 +0000 (+0000) Subject: Updates, according Laurent's advice X-Git-Tag: v0.9.0~7 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=56813a8c387f585ccbf5037d67ddfa71d7f94712;p=bbtk.git Updates, according Laurent's advice --- diff --git a/kernel/doc/bbtkWebSite/download.html b/kernel/doc/bbtkWebSite/download.html deleted file mode 100644 index e699c06..0000000 --- a/kernel/doc/bbtkWebSite/download.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Download - - -
Download
-

-
    - -
  1. Get the -latest stable release -
      -
    1. Sources
    2. -
    3. Linux rpm
    4. -
    5. Windows installer
    6. -
    -
  2. -
  3. Get the current -sources from -cvs repository -
      -
    1. Linux
    2. -
    3. Windows -with TortoiseCVS -
    4. -
    -
  4. -
-
-
- -
-

Get the -latest stable release

-

Sources
-

-
    -
  • Beta version 0.6.0 : tgz zip
  • -
  • Beta version 0.5.0 : tgz zip
    -
  • -
  • Beta version 0.3.0 : tgz zip
    -
  • -
  • Beta version 0.2.0 : tgz zip
    -
  • -
  • Beta version 0.1.0 : tgz zip 
  • -
-

Linux rpm

-    Linux rpms are currently only provided for Fedora -Core distros
- -

Windows installer

-
-
-
-
-

Get the current -sources from -cvs repository

-

Linux

-        > cvs co -d -:ext:username@cvs.creatis.insa-lyon.fr:/cvs/creatis bbtk
-
-

Windows -with TortoiseCVS
-

- -
    - -
  1. Login -with your public/private ssh key (Suggested program for -windows is Putty)
  2. - -
  3. Right -click over the folder C:\Creatis and select "import CVS module" in the -menu
  4. - -
  5. Select the options :
  6. - -
-        -- Server: cvs.creatis.insa-lyon.fr
-
        -- Module root folder: /cvs/creatis
-
        -- User name: The one used in email login
-
        -- Click on find the list of modules
-
        -- Select the "bbtk" module -
-
-
- - diff --git a/kernel/doc/bbtkWebSite/home.html b/kernel/doc/bbtkWebSite/home.html index dbd3282..15b1f54 100644 --- a/kernel/doc/bbtkWebSite/home.html +++ b/kernel/doc/bbtkWebSite/home.html @@ -6,22 +6,36 @@ Home -
The Black Box Toolkit
-
-

-
Wikipedia -defines a black box as "any component in a system in which -only the input and output characteristics are of interest, without -regard to its internal mechanism or structure". -
The Black Box Toolkit (bbtk) is -a set of tools (C++ libraries and executables) providing a C++ -framework for the definition of elementary processing units, -called black boxes, and the definition and execution of -processing chains made up of these black boxes.
+
+ +The Black Box Toolkit Documentation
+bbtk @BBTK_VERSION@ (@BBTK_VERSION_DATE@)
+

+ +
Follow this link if you need to build bbtk from +sources.
+
+Read the users' guide if you +want to learn how to use bbtk development environnement (bbStudio) and +how to write black box scripts.
+
+Read the package +developers' guide to learn how to create your own black boxes and +packages.
+
+Developers might also be interested in doxygen documentation of the +source code of bbtk library.
+
+The boxes lists contain the boxes of bbtk core packages (std,wx,vtk...) +for current version.
+
+All this documentation is also available from bbStudio.
+

-
diff --git a/kernel/doc/bbtkWebSite/install.html b/kernel/doc/bbtkWebSite/install.html index 8939595..c6a4e1e 100644 --- a/kernel/doc/bbtkWebSite/install.html +++ b/kernel/doc/bbtkWebSite/install.html @@ -8,8 +8,7 @@
-
- +
BBTK build instructions
@@ -39,20 +38,8 @@ BBTK build instructions style="font-weight: normal;">Requirements
  • cmake >= 2.4.6
  • -
  • wxWidgets  >=   -2.6.3 yum install -
      -
    • yum install wxGTK-devel -(fedora extras repos)
      -
    • -
    -
  • +2.6.3 
  • optional :
    • @@ -60,39 +47,11 @@ BBTK build instructions to generate the pdf doc
    • tth to generate the html doc
    • -
    • itk to compile packages itk, itkvtk
    • -
        -
      • yum install -InsightToolkit-devel (creatis repos)
        -
      • -
    • vtk to compile package vtk, wxvtk
      • -
      • 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
        • -
@@ -170,8 +129,7 @@ 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
@@ -203,50 +161,38 @@ highlighted in red -Windows- then type 'g', to generate.

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
  • -
  • wxWidgets-2.8.5 (sources) to +
  • 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
  • -
  • 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 +
  • Graphviz +to generate the graphs in doxygen doc and black box pipelines graphs 
  • @@ -255,7 +201,7 @@ graphs in doxygen doc and black box pipelines graphsKnown working configurations
      -
    • .net
      +
    • .net V7
    • cmake
    • @@ -288,106 +234,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
          • @@ -396,63 +256,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 ITKthe .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 @@ -488,7 +322,8 @@ indicate the dependencies on external libraries or utilities.


          - +
          - + - @@ -837,6 +672,15 @@ itk images of type unsigned  short ?
          style="vertical-align: top; background-color: rgb(204, 204, 204);">ON
          + + + + + @@ -853,12 +697,6 @@ Requires : itk, vtk
          - - - - - @@ -908,6 +746,22 @@ Requires : wxWidgets, vtk
          + + + + + + + + + +
          Option
          @@ -661,7 +496,7 @@ Requires : itk, vtk
          BUILD_BBTK_PACKAGE_std
          Build the package 'std' ?OFFON
          BUILD_BBTK_PACKAGE_toolsbbtk
          @@ -694,7 +529,7 @@ Requires : wxWidgets
          Build the package 'wxvtk' ?
          Requires : wxWidgets, vtk

          +
          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' ? /usr/local
          EXECUTABLE_OUTPUT_PATH
          +
          Single output directory for +building all the executables
          +
          -
          +
          LIBRARY_OUTPUT_PATHSingle output directory for +building all the libraries-
          +
          USE_BOOST
          diff --git a/kernel/doc/bbtkWebSite/menu.html b/kernel/doc/bbtkWebSite/menu.html index 505a050..fca9b7c 100644 --- a/kernel/doc/bbtkWebSite/menu.html +++ b/kernel/doc/bbtkWebSite/menu.html @@ -6,16 +6,10 @@ content="text/html; charset=iso-8859-1"> - -
          -The Black Box Toolkit @BBTK_VERSION@
          -
          -
          Build Instructions
          -
          -Follow this link
          -
          Guides and documentation
          + +Home
          +Build instructions

          +
          Guides and documentation
          User's