/[ascend]/trunk/INSTALL.txt
ViewVC logotype

Annotation of /trunk/INSTALL.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1434 - (hide annotations) (download)
Sun May 20 16:53:10 2007 UTC (11 years, 11 months ago) by ballan
File MIME type: text/plain
File size: 6083 byte(s)
test commit
1 johnpye 438 BUILDING AND INSTALLING ASCEND
2 aw0a 1
3 ballan 1434
4 johnpye 438 Thanks for downloading ASCEND! We hope you'll find it straight-
5     forward to set up and run ASCEND. If you have any comments on
6     your experience with this, we're very keen to hear about that.
7     Please check out the up-to-date contact details at:
8 jpye 1318 https://ascendserver.cheme.cmu.edu/wiki/
9 johnpye 146
10 johnpye 438 There are older versions of this document, which include instructions
11     on how to build ASCEND with GNU Autotools. This may or may not work
12 johnpye 476 with the version you are currently looking at.
13 jpye 1318 https://ascendserver.cheme.cmu.edu/svn/ascend/code/branches/extfn/INSTALL.txt?view=log
14 johnpye 146
15 johnpye 438 -----
16     BUILDING ON LINUX AND WINDOWS
17 johnpye 146
18 johnpye 438 To build ASCEND we now recommend using SCons. This is supported
19 johnpye 683 both on Windows (using the MinGW toolset) and Linux. Build scripts for using
20     jam and GNU Autotools are also provided although these scripts will not allow
21     you access to the full range of ASCEND functionality. The Autotools
22     scripts will only build the tcl/tk interface version.
23 aw0a 1
24 johnpye 438 ASCEND provides two possible interfaces. The older, more mature
25     GUI is based on Tcl/Tk. A newer interface that is more in keeping
26     with modern GUI design is implemented using PyGTK, but it is still
27 johnpye 683 missing some functionality and actively being developed.
28 aw0a 1
29 johnpye 683 Using SCons 0.96.92 or newer, see your build options by typing
30 aw0a 1
31 johnpye 559 scons -Qh
32 aw0a 1
33 johnpye 438 You can add your build options to a file in this directory
34 johnpye 765 which you can create, called 'config.py'. Otherwise you can
35     specify your build options via the commandline. By default they will
36     be recorded in the file 'options.cache', so watch out for that if scons
37     seems to not be doing what you expected.
38 aw0a 1
39 johnpye 438 Then to build ASCEND, type
40 aw0a 1
41 johnpye 559 scons
42 aw0a 1
43 johnpye 683 SCons will tell you what version(s) of ASCEND it is able to build, and then
44     proceed to start the build. The PyGTK interface requires Python (which is
45     already present if you have SCons!). The Tcl/Tk interface requires that you
46     have Tcl/Tk and TkTable installed on your system.
47 aw0a 1
48 johnpye 683 For updates on this information, and PLATFORM-SPECIFIC INFORMATION, please check
49 jpye 1318 http://ascendserver.cheme.cmu.edu/wiki/index.php/BuildingAscend
50 aw0a 1
51 johnpye 438 For specific information on building the Python interface and
52     setting up the PyGTK GUI, please see
53 jpye 1318 http://ascendserver.cheme.cmu.edu/wiki/index.php/PythonWrapper
54 aw0a 1
55 johnpye 438 ------
56 johnpye 988 BUILDING ON SOLARIS
57    
58     Some work has been done on building on Solaris, using Python 2.3. At present
59     it's pretty close but not yet stable. If you can help out, let us know.
60    
61     ------
62 johnpye 559 RUNNING FOR THE FIRST TIME
63    
64     If you've build ASCEND from source, you don't need to 'install'
65     it before you can run it. The main issue with running from the
66     source directories is that you need to set various environment
67     variables:
68    
69     ASCENDLIBRARY
70     Location of the 'models' directory, eg ~/src/ascend-NNN/models
71    
72     LD_LIBRARY_PATH
73     Must contain the paths to the ascend shared libraries, in
74     particular libascend.so, or for the Tcl/Tk interface, also
75     libascendtcl.so.
76    
77     It can often be easier to simply install in your home directory
78     as shown below.
79    
80     ------
81     ISSUES WITH THE TCL/TK INTERFACE
82    
83     It can sometimes be a bit challenging to build the Tcl/Tk
84 johnpye 649 interface. ASCEND can run with Tcl/Tk version 8.4 but it is more stable when
85     using Tcl/Tk version 8.3.
86    
87     A suggested approach in this case is to download and install the 'ActiveTcl'
88 johnpye 559 distribution, version 8.3.5, and to install it in ~/activetcl.
89     http://downloads.activestate.com/ActiveTcl/Windows/8.3.5/
90    
91     Then, you should be able to build the Tcl/Tk interface as shown:
92    
93     export LD_LIBRARY_PATH=~/activetcl/lib:~/activetcl/lib/Tktable2.8
94     scons TCL=~/activetcl
95    
96 johnpye 649 See also the TCL_LIB and TK_LIB flags (scons -Qh).
97    
98 johnpye 559 ------
99 johnpye 438 INSTALLING ON LINUX
100 aw0a 1
101 johnpye 438 To then install ASCEND, you will need to have write access to the
102 johnpye 765 directories INSTALL_* as specified in your SCons configuration.
103     You can then type:
104 aw0a 1
105 johnpye 559 scons install
106    
107     The simplest way to install ASCEND 'off-root' is something like:
108 aw0a 1
109 johnpye 559 scons INSTALL_PREFIX=~/ascroot
110    
111     Note that if you install (or run) ASCEND off-root, you need to
112     ensure that Linux can access the shared libraries. For example,
113     in the above case, you would need to add
114    
115     export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:~/ascroot/lib
116    
117 johnpye 438 ------
118     INSTALLING ON WINDOWS
119 aw0a 1
120 johnpye 476 To build a Windows installer (a 'setup.exe') for the PyGTK GUI,
121     you will need to have the NSIS installer-creator installed on
122     your system (which is free, at http://nsis.sf.net/). Then you
123     should simply need to type
124 aw0a 1
125 johnpye 649 scons installer
126 johnpye 476
127 johnpye 683 This will leave an installer package named 'ascend-NNNNN.exe'
128     in the pygtk/interface directory, with NNNNN being the version number specified
129     at the top of the SConstruct file.
130 johnpye 476
131 johnpye 438 ------
132 johnpye 765 A NOTE ABOUT PREFERENCES
133    
134     ASCEND PyGTK GUI stores your preferences in the file ~/.ascend.ini.
135     The Tcl/Tk GUI creates a file under ~/ascdata.
136     You may wish to check these files if ASCEND seems to be doing
137     something you didn't expect.
138    
139     ------
140 johnpye 438 CREATING AN RPM/DEB PACKAGE
141 aw0a 1
142 johnpye 438 Many users prefer to keep their systems clear of unpackaged
143     software. For this reason, we aim to provide the ability to build
144 johnpye 559 ASCEND as an RPM package. There is a "SPEC" file included in the
145 johnpye 476 source tree. If you have a source package, such as for example
146     ascend-NNNNN.tar.bz2, place it in your home directory, then
147     type the following
148 aw0a 1
149 johnpye 559 rpmbuild -ta ascend-NNNNN.tar.bz2
150 aw0a 1
151 johnpye 438 This will pull out the 'spec' from from the source package,
152     which hopefully will be up to date in correspondance with the
153     package version number NNNNN.
154 aw0a 1
155 johnpye 438 You will then be able to install ASCEND using something like
156 aw0a 1
157 johnpye 559 rpm -i ~/rpm/ascend-NNNNN-0.jdpipe.i386.rpm
158 aw0a 1
159 johnpye 438 Debian/Unbuntu users should find that they can create a usable
160     .deb package using the tool 'alien'. We haven't got native
161     support for the generation of .deb packages at this stage.
162 aw0a 1
163 johnpye 476 NOTE: occasionally the 'ascend.spec' file may need to be updated
164     if changes have been made to the 'ascend.spec.in' file. Check
165     the implementation details in the SConstruct file.
166    
167 johnpye 438 ------
168     GETTING SUPPORT AND FURTHER INFORMATION
169 aw0a 1
170 johnpye 438 For support with ASCEND, details of mailing lists and other
171     useful information, please visit
172 aw0a 1
173 johnpye 438 ASCEND user's website:
174     http://ascend.cheme.cmu.edu/
175 aw0a 1
176 johnpye 438 ASCEND developer's wiki:
177 jpye 1318 https://ascendserver.cheme.cmu.edu/wiki/
178 johnpye 989

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22