Changeset - f747a32958da
[Not reviewed]
default
0 6 0
Michael Guravage - 14 years ago 2011-02-16 10:52:07
michael.guravage@cwi.nl
Reworked the recipe a bit.

--
user: Michael Guravage <michael.guravage@cwi.nl>
branch 'default'
changed doc/Makefile
changed doc/installation.pdf
changed doc/installation.rst
changed doc/recipe.rst
changed doc/stylesheet.json
changed doc/v1.pdf
6 files changed with 85 insertions and 100 deletions:
0 comments (0 inline, 0 general)
doc/Makefile
Show inline comments
 
@@ -3,16 +3,21 @@
 
.rst.pdf :
 
	rst2pdf -s stylesheet.json $< -o $@
 

	
 
.rst.html :
 
	rst2html.py $< $@
 

	
 
all: v1.pdf v1.html
 
all: v1.pdf v1.html installation.pdf installation.html recipe.pdf recipe.html 
 

	
 
v1.pdf : v1.rst
 
v1.html : v1.rst
 

	
 
v1.html : v1.rst
 
installation.pdf : installation.rst
 
installation.html : installation.rst
 

	
 
recipe.pdf : recipe.rst
 
recipe.html : recipe.rst
 

	
 
clean:
 
	/bin/rm -f v1.pdf v1.html
 
	/bin/rm -f v1.pdf v1.html installation.pdf installation.html recipe.pdf recipe.html
 

	
 
#finis
 
\ No newline at end of file
doc/installation.pdf
Show inline comments
 
@@ -107,13 +107,13 @@ 9 0 obj
 
 /Pages 17 0 R
 
 /Type /Catalog >>
 
endobj
 
% 'R10': class PDFInfo 
 
10 0 obj
 
<< /Author ()
 
 /CreationDate (D:20100623150545-01'00')
 
 /CreationDate (D:20110216100041-01'00')
 
 /Keywords ()
 
 /Producer (ReportLab http://www.reportlab.com)
 
 /Subject (\(unspecified\))
 
 /Title (Installation Instructions) >>
 
endobj
 
% 'R11': class PDFOutlines 
 
@@ -361,13 +361,13 @@ q
 
BT 1 0 0 1 0 28.82 Tm 3.219979 Tw 12 TL /F1 10 Tf 0 0 0 rg (For convenience sake, three required development libraries: ) Tj /F3 10 Tf (libiconv) Tj /F1 10 Tf (, ) Tj /F3 10 Tf (libxml2 ) Tj /F1 10 Tf (and ) Tj /F3 10 Tf (libz ) Tj /F1 10 Tf (are ) Tj T* 0 Tw .387318 Tw (distributed with the VirtualLeaf code, and the VirtualLeaf will compile correctly with them. If, however, you ) Tj T* 0 Tw .590651 Tw (wish to use other versions of these libraries, you will need to reassign the ) Tj /F3 10 Tf (LIBICONVDIR) Tj /F1 10 Tf (, ) Tj /F3 10 Tf (LIBZML2DIR) Tj T* 0 Tw ET
 
Q
 
Q
 
q
 
1 0 0 1 56.69291 773.1969 cm
 
q
 
BT 1 0 0 1 0 4.82 Tm 160.0749 0 Td 12 TL /F1 10 Tf 0 0 0 rg (Installation Instructions - 2010-06-23) Tj T* -160.0749 0 Td ET
 
BT 1 0 0 1 0 4.82 Tm 160.0749 0 Td 12 TL /F1 10 Tf 0 0 0 rg (Installation Instructions - 2011-02-16) Tj T* -160.0749 0 Td ET
 
Q
 
Q
 
q
 
1 0 0 1 56.69291 56.69291 cm
 
q
 
0 0 0 rg
 
@@ -504,13 +504,13 @@ q
 
BT 1 0 0 1 0 16.82 Tm 6.059213 Tw 12 TL /F1 10 Tf 0 0 0 rg (When complete, you will find the ) Tj /F3 10 Tf (VirtualLeaf ) Tj /F1 10 Tf (binary in ) Tj /F3 10 Tf (v1.0/bin ) Tj /F1 10 Tf (and the plugins in) Tj T* 0 Tw /F3 10 Tf (v1.0/bin/models) Tj /F1 10 Tf (.) Tj T* ET
 
Q
 
Q
 
q
 
1 0 0 1 56.69291 773.1969 cm
 
q
 
BT 1 0 0 1 0 4.82 Tm 160.0749 0 Td 12 TL /F1 10 Tf 0 0 0 rg (Installation Instructions - 2010-06-23) Tj T* -160.0749 0 Td ET
 
BT 1 0 0 1 0 4.82 Tm 160.0749 0 Td 12 TL /F1 10 Tf 0 0 0 rg (Installation Instructions - 2011-02-16) Tj T* -160.0749 0 Td ET
 
Q
 
Q
 
q
 
1 0 0 1 56.69291 56.69291 cm
 
q
 
0 0 0 rg
 
@@ -566,13 +566,13 @@ 0000009748 00000 n
 
0000015657 00000 n
 
0000015763 00000 n
 
0000015840 00000 n
 
trailer
 
<< /ID 
 
 % ReportLab generated PDF document -- digest (http://www.reportlab.com) 
 
 [(\361i\357\326\223\205\376 cX\3301\266\222\010\004) (\361i\357\326\223\205\376 cX\3301\266\222\010\004)] 
 
 [(&q\332\037\311\250\223EgHo\314\021\224\013\364) (&q\332\037\311\250\223EgHo\314\021\224\013\364)] 
 
 
 /Info 10 0 R
 
 /Root 9 0 R
 
 /Size 23 >>
 
startxref
 
15887
doc/installation.rst
Show inline comments
 
@@ -6,13 +6,13 @@
 
.. header::
 
  ###Title###  -  |date|
 

	
 
.. footer::
 
  ###Page### 
 

	
 

	
 
=========================
 
Installation Instructions
 
=========================
 

	
 
Requirements
 
------------
 

	
doc/recipe.rst
Show inline comments
 
@@ -6,81 +6,68 @@
 
.. header::
 
  ###Title###  -  |date|
 

	
 
.. footer::
 
  ###Page### 
 

	
 

	
 
============
 
Virtual Leaf
 
============
 

	
 
------------------
 
Linux Installation
 
------------------
 

	
 
Material
 
++++++++
 
  #. The Virtual Leaf source code
 
  #. `QT SDK <http://qt.nokia.com>`_
 
````````
 
#. The Virtual Leaf source code from http://virtualleaf.googlecode.com/files/VirtualLeaf-v1.0-src.zip.
 
#. The QT SDK from http://qt.nokia.com.
 
  #. Development Systems will have many of these items already installed:
 

	
 
    #. Python programming language
 
    #. `Mercurial revision control system <http://mercurial.selenic.com/wiki>`_
 
    #. KDiff2 diff/merge tool.
 
    #. GCC, The GNU Compiler Collection
 
    #. GNU Make
 
    #. Iconv conversion utilities
 
    #. Perl programming language
 
    #. Zlib compression library
 
    #. Libxml2 XML parser
 

	
 
Methods
 
+++++++
 
  #. Install the aforementioned development software.  The following
 
     commands should show meaningful output::
 
```````
 

	
 
      python --version
 
      hg --version
 
#. Install the aforementioned development software. If any of these
 
   are missing, ask your system administrator to install them for
 
   you. The following commands should show meaningful output::
 

	
 
      gcc --version 
 
      make --version
 
      iconv --version
 
      perl --version
 
      locate libz.so
 
      locate libxml2.so
 

	
 

	
 
  #. The VirtualLeaf is written with the QT Cross platform application
 
     and UI framework. To compile the VirtualLeaf from source you will
 
     need to install the QT software development kit(SDK), which you
 
     can download from the `QT download site <http://qt.nokia.com/downloads/downloads>`_.
 
   can download from the QT download site: ``http://qt.nokia.com/downloads/downloads>``.
 

	
 
  #. Whether installed globally by a system administrator our locally in
 
     your own user space, make sure the QT bin directory containing qmake
 
     is in your execution path, e.g.::
 

	
 
      > PATH=/opt/QT/qt/bin:$PATH 
 

	
 
  #. Create a Mercurial configuration file named .hgrc in your home
 
     directory containing the following lines::
 

	
 
      [ui]
 
        username = Your Name <your e-mail address>
 
        merge = kdiff3
 

	
 
      [extdiff]
 
        cmd.vdiff = kdiff3
 

	
 
      [merge-tools]
 
        diffFiles.args = $local $other $base 
 
        kdiff3.args = $base $local $other -o $output
 

	
 
  #. Make or change to the directory where you wish to install the Virtual Leaf::
 

	
 
      > cd /home/michael/simulations
 

	
 
  #. Retrieve the Virtual Leaf source code from its  Google Code repository::
 

	
 
      > hg clone https://virtualleaf.googlecode.com/hg/ virtualleaf
 
    > wget http://virtualleaf.googlecode.com/files/VirtualLeaf-v1.0-src.zip
 
    > unzip http://virtualleaf.googlecode.com/files/VirtualLeaf-v1.0-src.zip
 

	
 
  #. Compilation is effected with make. To facilitate cross platform
 
     compatibility, the makefiles use two environment variables:
 
     ``MAKE`` and ``QMAKE`` to name the make and QT-make utilities
 
     respectively. The fallback defaults are ``make`` and ``qmake``. 
 
     If you wish to use some other ``make`` or ``qmake`` utilities other
 
@@ -100,77 +87,67 @@ Methods
 
      > cd /home/michael/simulations/virtualleaf/src
 
      > make -f Makefile
 

	
 
     Once the compilation is complete, you will find the ``VirtualLeaf``
 
     binary in ``virtualleaf/bin`` and the plugins in ``virtualleaf/bin/models``.
 

	
 

	
 
Windows
 
-------
 
--------------------
 
Windows Installation
 
--------------------
 

	
 
Material
 
++++++++
 
  #. The Virtual Leaf source code
 
  #. QT SDK:  http://get.qt.nokia.com/qtsdk/qt-sdk-win-opensource-2010.02.1.exe
 
````````
 
#. The Virtual Leaf source code from http://virtualleaf.googlecode.com/files/VirtualLeaf-v1.0-src.zip.
 

	
 
#. The QT SDK from http://get.qt.nokia.com/qtsdk/qt-sdk-win-opensource-2010.02.1.exe.
 

	
 
  #. Development Systems most likely will have most of the items in the following list already installed:
 

	
 
     #. Python programming language
 
     #. `Mercurial <http://mercurial.selenic.com/wiki/Download#Windows>`_ revision control system .
 
     #. `KDiff3 diff/merge tool <http://sourceforge.net/projects/kdiff3/files/>`_.
 
     #. `Iconv conversion utilities <http://sourceforge.net/projects/mingw/files/MinGW/libiconv/libiconv-1.13/>`_ 
 
        (rename libiconv.dll.a to libiconv.a).
 
     #. `Perl programming language <http://strawberry-perl.googlecode.com/files/strawberry-perl-5.10.1.1.msi>`_.
 
     #. `Zlib compression library <http://sourceforge.net/projects/mingw/files/MinGW/zlib/zlib-1.2.3-1-mingw32/>`_.
 
     #. `libz-1.dll <http://sourceforge.net/projects/mingw/files/MinGW/zlib/zlib-1.2.3-1-mingw32/>`_ (rename to zlib1.dll).
 
     #. Libxml2 XML parser: from ftp://ftp.zlatkovic.com/libxml/ or ftp://xmlsoft.org/libxml2/win32.
 
   #. KDiff3 diff/merge tool http://sourceforge.net/projects/kdiff3/files.
 

	
 
   #. Iconv utilities http://sourceforge.net/projects/mingw/files/MinGW/libiconv/libiconv-1.13 (rename libiconv.dll.a to libiconv.a).
 

	
 
   #. Perl http://strawberry-perl.googlecode.com/files/strawberry-perl-5.10.1.1.msi.
 

	
 
   #. Zlib library ftp://sourceforge.net/projects/mingw/files/MinGW/zlib/zlib-1.2.3-1-mingw32.
 

	
 
   #. libz-1.dll  http://sourceforge.net/projects/mingw/files/MinGW/zlib/zlib-1.2.3-1-mingw32 (rename to zlib1.dll).
 

	
 
   #. Libxml2 XML parser ftp://ftp.zlatkovic.com/libxml or ftp://xmlsoft.org/libxml2/win32. 
 

	
 
        Or compile from source::
 

	
 
          git clone git://git.gnome.org/libxml2
 

	
 
        To obviate compilation problems with mingw see:
 
         #. https://bugzilla.gnome.org/show_bug.cgi?id=561340 
 
         #. http://osdir.com/ml/gnome.lib.xml.general/2004-02/msg00007.html
 
         #. http://www.c-plusplus.de/forum/viewtopic-var-t-is-260421.html 
 
         #. http://markmail.org/message/rlpeuruibg2ruqqv 
 

	
 

	
 
Methods
 
+++++++
 
  #. Install the aforementioned development software.
 
```````
 
#. Install the aforementioned development software. If any of these
 
   are missing, ask your system administrator to install them for
 
   you.
 

	
 
  #. The VirtualLeaf is written with the QT Cross platform application
 
     and UI framework. To compile the VirtualLeaf from source you will
 
     need to install the QT software development kit(SDK), which you
 
     can download from the `QT download site <http://qt.nokia.com/downloads/downloads>`_.
 

	
 
  #. Create a Mercurial configuration file named .hgrc in your `home
 
     directory <http://mercurial.selenic.com/wiki/WindowsInstall#Setup_environment>`_::
 

	
 
       Notepad "C:\Documents and Settings\your_name\.hgrc"
 

	
 
     Add these lines to the configuration file::
 

	
 
       [ui]
 
         editor = Notepad
 
         username = your_name <your_email_address>
 

	
 
       [merge-tools]
 
         kdiff3.priority=-1
 
         kdiff3.args=-L1 base --L2 local --L3 other $base $local $other -o $output
 
         kdiff3.regkey=Software\KDiff3
 
         kdiff3.regappend=\kdiff3.exe
 
         kdiff3.fixeol=True
 
         kdiff3.gui=True
 

	
 
  #. Make or change to the directory where you wish to install the Virtual Leaf::
 
#. Make or change to the folder where you wish to install the Virtual Leaf::
 

	
 
      > c:\Documents and Settings\michael\simulations
 

	
 
  #. Retrieve the Virtual Leaf source code from its  Google Code repository::
 
#. Retrieve the Virtual Leaf source code from its Google Code
 
   repository by typing
 
   http://virtualleaf.googlecode.com/files/VirtualLeaf-v1.0-src.zip
 
   into your browser. Unpack the archive and place its contents in
 
   the folder named in the previous step.
 

	
 
      > hg clone https://virtualleaf.googlecode.com/hg/ virtualleaf
 

	
 
  #. Compilation is effected with make. To facilitate cross platform
 
     compatibility, the makefiles use two environment variables:
 
     ``MAKE`` and ``QMAKE`` to name the make and QT-make utility
 
     respectively. The fallback defaults are ``make`` and
 
     ``qmake``. Since QT executable names are consistent across
 
@@ -209,26 +186,26 @@ Methods
 
       > c:\Documents and Settings\michael\simulations\virtualleaf\src
 
       > mingw32-make -f Makefile
 

	
 
     When complete, you will find the ``VirtualLeaf.exe`` binary in
 
     ``v1.0/bin`` and the plugins in ``v1.0/bin/models``.
 

	
 

	
 
MacOS
 
-----
 
------------------
 
MacOS Installation
 
------------------
 

	
 
Material
 
++++++++
 
````````
 

	
 
  Identical to the Linux installation except that instead of GNU GCC
 
  and Make, install the XCode development environment from the MacOSX
 
  installation DVDs.
 

	
 

	
 
Methods
 
+++++++
 
```````
 

	
 
  Identical to the Linux installation except:
 
    #. Open the Terminal program (in ``/Applications/Utilities/``) and
 
       retrieve the Virtual Leaf source code from its Google Code
 
       repository::
 

	
doc/stylesheet.json
Show inline comments
 
@@ -213,16 +213,19 @@
 
    ["item_list_item" , {
 
      "parent": "bodytext",
 
      "spaceBefore":-3
 
    }],
 
    ["enumerated_list" , {
 
      "parent": "bodytext",
 
      "spaceBefore": 0
 
      "spaceBefore": 0,
 
      "spaceAfter": 0
 
    }],
 
    ["enumerated_list_item" , {
 
      "parent": "bodytext"
 
      "parent": "bodytext",
 
      "spaceBefore": 0,
 
      "spaceAfter": 0
 
    }],
 
    ["definition_list_term" , {
 
      "parent": "normal",
 
      "fontName": "stdBold",
 
      "spaceBefore": 4,
 
      "spaceAfter": 0,
 
@@ -262,13 +265,13 @@
 
      "spaceAfter": 6
 
    }],
 
    ["title" , {
 
      "parent": "heading",
 
      "fontName": "stdBold",
 
      "fontSize": "200%",
 
      "alignment": "TA_LEFT",
 
      "alignment": "TA_CENTER",
 
      "keepWithNext": false,
 
      "spaceAfter": 10
 
    }],
 
    ["subtitle" , {
 
      "parent": "title",
 
      "spaceBefore": 12,
doc/v1.pdf
Show inline comments
 
@@ -461,13 +461,13 @@ 30 0 obj
 
 /Pages 62 0 R
 
 /Type /Catalog >>
 
endobj
 
% 'R31': class PDFInfo 
 
31 0 obj
 
<< /Author ()
 
 /CreationDate (D:20101015155138-01'00')
 
 /CreationDate (D:20110216100033-01'00')
 
 /Keywords ()
 
 /Producer (ReportLab http://www.reportlab.com)
 
 /Subject (\(unspecified\))
 
 /Title (The Virtual Leaf) >>
 
endobj
 
% 'R32': class PDFOutlines 
 
@@ -839,20 +839,20 @@ 62 0 obj
 
 29 0 R ]
 
 /Type /Pages >>
 
endobj
 
% 'R63': class PDFStream 
 
63 0 obj
 
% page stream
 
<< /Length 8892 >>
 
<< /Length 8921 >>
 
stream
 
1 0 0 1 0 0 cm BT /F1 12 Tf 14.4 TL ET
 
q
 
1 0 0 1 62.69291 729.0236 cm
 
q
 
0 0 0 rg
 
BT 1 0 0 1 0 9.64 Tm /F2 20 Tf 24 TL (The Virtual Leaf) Tj T* ET
 
BT 1 0 0 1 0 9.64 Tm /F2 20 Tf 24 TL 159.9249 0 Td (The Virtual Leaf) Tj T* -159.9249 0 Td ET
 
Q
 
Q
 
q
 
1 0 0 1 62.69291 696.0236 cm
 
q
 
BT 1 0 0 1 0 8.435 Tm 21 TL /F2 17.5 Tf 0 0 0 rg (Friday 11 June 2010) Tj T* ET
 
@@ -3281,29 +3281,29 @@ 0000012780 00000 n
 
0000012955 00000 n
 
0000013157 00000 n
 
0000013385 00000 n
 
0000013558 00000 n
 
0000013719 00000 n
 
0000013870 00000 n
 
0000022863 00000 n
 
0000027768 00000 n
 
0000034521 00000 n
 
0000048763 00000 n
 
0000056736 00000 n
 
0000061413 00000 n
 
0000061571 00000 n
 
0000061648 00000 n
 
0000061725 00000 n
 
0000061802 00000 n
 
0000061879 00000 n
 
0000061956 00000 n
 
0000022892 00000 n
 
0000027797 00000 n
 
0000034550 00000 n
 
0000048792 00000 n
 
0000056765 00000 n
 
0000061442 00000 n
 
0000061600 00000 n
 
0000061677 00000 n
 
0000061754 00000 n
 
0000061831 00000 n
 
0000061908 00000 n
 
0000061985 00000 n
 
trailer
 
<< /ID 
 
 % ReportLab generated PDF document -- digest (http://www.reportlab.com) 
 
 [(\216\375C\374\237e3\302\016\020\3752\364q\006\373) (\216\375C\374\237e3\302\016\020\3752\364q\006\373)] 
 
 [(\037\323\227O\300\021\334\027\205\315\374[\264\010]\323) (\037\323\227O\300\021\334\027\205\315\374[\264\010]\323)] 
 
 
 /Info 31 0 R
 
 /Root 30 0 R
 
 /Size 76 >>
 
startxref
 
62003
 
62032
 
%%EOF
0 comments (0 inline, 0 general)