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

Contents of /trunk/INSTALL.txt

Parent Directory Parent Directory | Revision Log Revision Log


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

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