Doc/DoxyDevelInstal.txt

   1 /**
   2  * \page DoxyDevelInstal Developpers workspace
   3  * There is no further requirements than the ones of \ref DoxyInstallation.
   4  * But the developpers generally have further needs than the library user
   5  * like :
   6  * - in place debugging (in place as opposed to fully
   7  *   installed, i.e. when working in the cvs hierarchy or in the hierarchy
   8  *   build from gdcm source tar ball).
   9  * - tests of features
  10  * - test suite usage (typically after code modifications and prior to
  11  *   commit).
  12  * .
  13  * In the following we shall assume that gdcm is allready compiled-
  14  * BUT not installed- in a directory named <TT>GDCM_HOME</TT>.
  15  *
  16  * \section DoxyDevelInstalCPlusPlus Working with C++
  17  *   The kernel library uses the environnement variable
  18  *   <TT>GDCM_DICT_PATH</TT> as a path to the location of the default
  19  *   Dicom dictionary. Hence if you which to work/debug a code based
  20  *   on gdcm, you first need to positionate this variable. When omitting
  21  *   this you should get the following message:
  22  * <TT>gdcmDict::gdcmDict: can't open dictionary /usr/local/share/gdcm/dicomV3.dic</TT>
  23  *
  24  *   Suppose you want to launch some C++ demo/test program, that
  25  *   gets compiled with the kernel, e.g. PrintHeader. One can do
  26  *    - <TT>cd GDCM_HOME</TT>
  27  *    - <TT>export GDCM_DICT_PATH=`pwd`/Dicts</TT>
  28  *    - <TT>cd Test</TT>
  29  *    - <TT>./PrintHeader</TT>
  30  *    .
  31  * \section DoxyDevelInstalPython Working with Python
  32  *    - <TT>cd GDCM_HOME</TT>
  33  *    - <TT>./autogen.sh --enable-python</TT>
  34  *    - <TT>make</TT>
  35  *    - <TT>export PYTHONPATH=`pwd`</TT>
  36  *    - <TT>cd gdcmPython</TT>
  37  *    - <TT>ln -s .libs/pygdcm.so _gdcm.so</TT> (this is because automake
  38  *      doesn't allow the building of libraries whose name starts with an
  39  *      underscore. Since we need the wrapper library to be named _gdcm
  40  *      [because swig automaticatily uses this name when building the
  41  *       shadow classes], automake generates pygdcm.so and at install stage
  42  *       stage renames it to _gdcm.so).
  43  *    - You can then use gdcmPython for manual test/demos
  44  *       -# <TT>cd GDCM_HOME/gdcmPython/demo</TT>
  45  *       -# <TT>python PrintHeader.py</TT>
  46  *        .
  47  *    - You can also run the gdcm test suite, which is written in Python:
  48  *       -# first you need to install the Dicom data files used by the
  49  *          test suite. The cvs access point is
  50  *          <TT>:pserver:anonymous@cvs.creatis.insa-lyon.fr:2402/cvs/public</TT>
  51  *          and the name of the module is <TT>gdcmData</TT>.
  52  *          Checkout this module in <TT>GDCM_HOME</TT> directory
  53  *       -# <TT>cd GDCM_HOME/gdcmPython/</TT>
  54  *       -# <TT>python testSuite.py</TT>
  55  *        .
  56  *     .
  57  */