e745967686972ac5f58bfc11b53f5fbfabb37c40
[charm.git] / README.win
1
2                           Charm++ for Win32/64
3
4        Copyright (C) 1989-2004 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
10 Note that since November 2005, Windows98 is not supported with VC++.
11 Support for WindowsNT/XP is improved to take advantage of the creation of
12 symbolic link under WindowsNT.
13 Please read the FAQ at end of this file.
14
15
16                        Setup and Compilation
17                     ===========================
18 (Note: building charm++ for 64-bit windows follows the exact way of building
19  for 32-bit windows. Therefore, changing "win32" to "win64" in the following 
20  paragraphs gives you the guide to build charm++ for 64-bit windows.)
21
22 To compile charm with VC++:
23 1. install cygwin from: http://sourceware.cygnus.com/cygwin
24    Remember to choose default file type as "unix" at the beginning of 
25    cygwin installation.
26
27 2. Start a Cygwin's Bash Shell window, type "cl" to make sure VC++ compiler 
28    command line mode is correctly set. If it is not correctly set, you need to 
29    run the VCVARS32.BAT at Windows startup time. VCVARS32.BAT can be located in
30    your VC++ install directory, usually at: 
31    /Program Files/Microsoft Visual Studio/VC98/Bin
32    However VCVARS32.BAT(a DOS Batch) cannot be executed under Bash Shell 
33    , you have to: for Win8x, put it into AUTOEXEC.BAT; for WinNT, 
34    you have to merge call VCVARS32.BAT in cygwin.bat which is the target of the
35    Cygwin icon on desktop. Note that this dos batch is renamed to 
36    vcvarsall.bat for VC++ version 8.
37    For example, if cygwin is installed under c:\cygwin,
38    modify c:\cygwin\cygwin.bat to something like:
39
40    >>>>>>>>>>>>>>>>>>>
41    @echo off
42
43    call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall" x86
44
45    C:
46    chdir D:\cygwin\bin
47
48    bash --login -i
49    >>>>>>>>>>>>>>>>>>>>
50
51 3. This step is optional if you have installed Microsoft Visual Studio under 
52    the following (default) location: 
53      /Program Files/Microsoft Visual Studio 8\VC
54    In case it is not at this directory, edit the following (text) files to 
55    modify them to point to your visual studio c++ compiler directory:
56     src\arch\win32\unix2nt_ar
57     src\arch\win32\unix2nt_cc  
58
59 4. Now you can compile Charm++ like Unix, for example:
60
61    ./build charm++ net-win32
62
63    this will build all Charm++ executables under net-win32/bin and all libs
64    under net-win32/lib
65
66
67
68                      Compile and Run Charm++ Programs
69                   ======================================
70
71 1. After Charm++ compilation is complete, you can try some sample programs under
72    net-win32\pgms. For example, 
73    cd net-win32/pgms/charm++/megatest, and type "make",
74    it will invoke Charm++'s "charmc"(VC++ wrapper) to compile the test 
75    programs and generates an executable "pgm.exe" and a charm++'s parallel
76    run utility program - "charmrun.exe".
77    Now you have two choices of running the executable:
78    (1) locally on your desktop, using:
79        ./charmrun +p1 ./pgm ++local
80        this will fork one copy of node program on your local machine. You can 
81        choose using more than one virtual processors, e.g. using +p3  option.
82        Starting from Charm 5.4R2, You can also run, simply type executable and 
83        command line options:
84        ./pgm 
85        This will run only one copy of program locally.
86
87    (2) run in parallel across machines:
88        In this case, you need to write a .nodelist file under your home
89        directory(~) in bash terminal, here is an example:
90
91 group main
92 host hostname1
93 host hostname2 
94
95        Next, you need to start charmd.exe, which is under net-win32/bin on
96        all the nodes as listed in the .nodelist file.
97        Now run the Charm++ program, for example:
98        ./charmrun +p2 ./pgm
99
100
101    For details of Charm++ compilation options and charmrun comman line options
102 explanation, please check the manuals on charm.cs.uiuc.edu web site manual 
103 section.
104    If you have any problem or suggestion, please let me know by sending
105 email to (ppl@cs.uiuc.edu).
106
107
108
109                                     FAQ
110                               ==============
111
112
113  1. I don't like Cygwin, can I compile Charm++ without Cygwin?
114
115    Yes, there is an un-documented way to compile Charm++ under MS-DOS windows 
116    with VC++ and nmake. However, this is only occasionally maintained and not 
117    guarranteed to always work.
118    Follow this steps:
119    1 open a MS-DOS windows, cd to Charm++ directory, and mkdir net-win32\tmp;
120    2 cd to net-win32\tmp, copy Makefile.win32 from 
121      charm\src\Common\scripts\Makefile.win32 to current directory;
122    3 type: nmake /f Makefile.win32
123    4 To compile Charm++ programs, see the Makefile.win32 examples under
124      net-win32\pgms\charm++\megatest\Makefile.win32
125      The command to use is: nmake /f Makefile.win32
126      Basically you need to specify all the charm++ libraries to link against,
127      because shell script charmc is not available,
128
129  2. I just downloaded Charm++ net-win32 binaries from your website, how to use it?
130
131    The recommended way to run windows binary is under Cygwin.
132    First, unzip the binary packages to desired location; Set PATH environment
133    varaible to include the charm bin/ directory. That's it, you can now cd 
134    to Charm++ testsuite directory, for example: pgms/charm++/megatest, to 
135    compile your first Charm++ program using "make".
136    If you don't want to use Cygwin, you have to use "nmake" to compile Charm++
137    programs, see the Makefile example under: 
138    pgms/charm++/megatest/Makefile.win32.
139
140  3. How to compile under Windows98?
141
142    Compiling Charm++ with cygwin/gnu compiler (net-cygwin) under Windows98 
143    is still supported. However, we don't support VC++ with Windows98 any more.
144    To compile Charm++ under Windows98, one can check out Charm++ version
145    before November 2005.