Just pull CMK_QT out of Charm config files, rather than having
[charm.git] / README.win32
1
2                           Charm++ for Win32
3
4        Copyright (C) 1989-2000 Regents of the University of Illinois
5
6 You can compile charm++ under Windows9x/2000/NT with VC++ plus Cygwin.
7 Cygwin are ports of the popular GNU development tools and utilities for 
8 Windows 9x/2K and NT, which emulates a UNIX environment under Windows.
9 If you are not comfortable with Cygwin, you still can compile Charm++ with
10 VC++, but this is not prefered, see FAQ below for help.
11
12
13                        Setup and Compilation
14                     ===========================
15
16 To compile charm with VC++:
17 1. install cygwin from: http://sourceware.cygnus.com/cygwin
18    Remember to choose default file type as "unix" at the beginning of 
19    cygwin installation.
20
21 2. Start a Cygwin's Bash Shell window, type "cl" to make sure VC++ compiler 
22    command line mode is correctly set. If it is not correctly set, you need to 
23    run the VCVARS32.BAT at Windows startup time. VCVARS32.BAT can be located in
24    your VC++ install directory, usually at: 
25    /Program Files/Microsoft Visual Studio/VC98/Bin
26    However VCVARS32.BAT(a DOS Batch) cannot be executed under Bash Shell 
27    , you have to: for Win8x, put it into AUTOEXEC.BAT; for WinNT, you 
28    have to merge the settings in VCVARS32.BAT into your environment varaibles 
29    settings(the most important one is the PATH varaible)  
30
31 3. Now you can compile Charm++ like Unix, for example:
32
33    ./build charm++ net-win32
34
35    this will build all Charm++ executables under net-win32/bin and all libs
36    under net-win32/lib
37
38
39
40                      Compile and Run Charm++ Programs
41                   ======================================
42
43 1. After Charm++ compilation is complete, you can try some sample programs under
44    net-win32\pgms. For example, 
45    cd net-win32/pgms/charm++/megatest, and type "make",
46    it will invoke Charm++'s "charmc"(VC++ wrapper) to compile the test 
47    programs and generates an executable "pgm.exe" and a charm++'s parallel
48    run utility program - "charmrun.exe".
49    Now you have two choices of running the executable:
50    (1) locally on your desktop, using:
51        ./charmrun +p1 ./pgm ++local
52        this will fork one copy of node program on your local machine. You can 
53        choose using more than one virtual processors, e.g. using +p3  option.
54        Starting from Charm 5.4R2, You can also run, simply type executable and 
55        command line options:
56        ./pgm 
57        This will run only one copy of program locally.
58
59    (2) run in parallel across machines:
60        In this case, you need to write a .nodelist file under your home
61        directory(~) in bash terminal, here is an example:
62
63 group main
64 host hostname1
65 host hostname2 
66
67        Next, you need to start charmd.exe, which is under net-win32/bin on
68        all the nodes as listed in the .nodelist file.
69        Now run the Charm++ program, for example:
70        ./charmrun +p2 ./pgm
71
72
73    For details of Charm++ compilation options and charmrun comman line options
74 explanation, please check the manuals on charm.cs.uiuc.edu web site manual 
75 section.
76    If you have any problem or suggestion, please let me know by sending
77 email to (ppl@uiuc.edu).
78
79
80
81                                     FAQ
82                               ==============
83
84
85  1. I don't like Cygwin, can I compile Charm++ without Cygwin?
86
87    Yes, there is an un-documented way to compile Charm++ under MS-DOS windows 
88    with VC++ and nmake. This is occasionally maintained and not guarranteed 
89    to be always working.
90    Follow this steps:
91    1 open a MS-DOS windows, cd to Charm++ directory, and mkdir net-win32\tmp;
92    2 cd to net-win32\tmp, copy Makefile.win32 from 
93      charm\src\Common\scripts\Makefile.win32 to current directory;
94    3 type: nmake /f Makefile.win32
95    4 To compile Charm++ programs, see the Makefile.win32 examples under
96      net-win32\pgms\charm++\megatest\Makefile.win32
97      The command to use is: nmake /f Makefile.win32
98      Basically you need to specify all the charm++ libraries to link against,
99      because shell script charmc is not available,
100
101  2. I just downloaded Charm++ net-win32 binaries from your website, how to use it?
102
103    The recommended way to use windows binary package is still under Cygwin.
104    First, unzip the binary packages to desired location; Set PATH environment
105    varaible to include the charm bin/ directory. That's it, you can now cd 
106    to Charm++ testsuite directory, for example: pgms/charm++/megatest, to 
107    compile your first Charm++ program using "make".
108    If you don't want to use Cygwin, you have to use "nmake" to compile Charm++
109    programs, see the Makefile example under: 
110    pgms/charm++/megatest/Makefile.win32.
111
112