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

Contents of /trunk/INSTALL.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 649 - (show annotations) (download)
Tue May 30 01:39:25 2006 UTC (12 years, 5 months ago) by johnpye
File MIME type: text/plain
File size: 5196 byte(s)
Some small updates to the installation instructions (accept Tcl/Tk 8.4 now)
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://pse.cheme.cmu.edu/wiki/view/Ascend/WebHome
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://pse.cheme.cmu.edu/svn-view/ascend/code/trunk/INSTALL?view=log
13
14 -----
15 BUILDING ON LINUX AND WINDOWS
16
17 To build ASCEND we now recommend using SCons. This is supported
18 both on Windows (using the MinGW toolset) and Linux. Their fans
19 will also find build tools for jam and autotools. The autotools
20 build is still maintained for at least the tcl/tk interface version.
21
22 ASCEND provides two possible interfaces. The older, more mature
23 GUI is based on Tcl/Tk. A newer interface that is more in keeping
24 with modern GUI design is implemented using PyGTK, but it is still
25 missing some functionality.
26
27 Using SCons 0.96.91 or newer, see your build options by typing
28
29 scons -Qh
30
31 You can add your build options to a file in this directory
32 which you can create, called 'config.py'.
33
34 Then to build ASCEND, type
35
36 scons
37
38 SCons will tell you what version(s) of ASCEND it is able to build.
39 The PyGTK interface requires Python (which is present if you have
40 SCons). The Tcl/Tk interface requires that you have Tcl/Tk and
41 TkTable installed on your system.
42
43 For updates on this information, please check
44 https://pse.cheme.cmu.edu/wiki/view/Ascend/BuildingAscend
45
46 For specific information on building the Python interface and
47 setting up the PyGTK GUI, please see
48 https://pse.cheme.cmu.edu/wiki/view/Ascend/PythonWrapper
49
50 ------
51 RUNNING FOR THE FIRST TIME
52
53 If you've build ASCEND from source, you don't need to 'install'
54 it before you can run it. The main issue with running from the
55 source directories is that you need to set various environment
56 variables:
57
58 ASCENDLIBRARY
59 Location of the 'models' directory, eg ~/src/ascend-NNN/models
60
61 LD_LIBRARY_PATH
62 Must contain the paths to the ascend shared libraries, in
63 particular libascend.so, or for the Tcl/Tk interface, also
64 libascendtcl.so.
65
66 It can often be easier to simply install in your home directory
67 as shown below.
68
69 ------
70 ISSUES WITH THE TCL/TK INTERFACE
71
72 It can sometimes be a bit challenging to build the Tcl/Tk
73 interface. ASCEND can run with Tcl/Tk version 8.4 but it is more stable when
74 using Tcl/Tk version 8.3.
75
76 A suggested approach in this case is to download and install the 'ActiveTcl'
77 distribution, version 8.3.5, and to install it in ~/activetcl.
78 http://downloads.activestate.com/ActiveTcl/Windows/8.3.5/
79
80 Then, you should be able to build the Tcl/Tk interface as shown:
81
82 export LD_LIBRARY_PATH=~/activetcl/lib:~/activetcl/lib/Tktable2.8
83 scons TCL=~/activetcl
84
85 See also the TCL_LIB and TK_LIB flags (scons -Qh).
86
87 ------
88 INSTALLING ON LINUX
89
90 To then install ASCEND, you will need to have write access to the
91 directories INSTALL_DATA, INSTALL_BIN as specified in your
92 SCons configuration. You can then type
93
94 scons install
95
96 The simplest way to install ASCEND 'off-root' is something like:
97
98 scons INSTALL_PREFIX=~/ascroot
99
100 Note that if you install (or run) ASCEND off-root, you need to
101 ensure that Linux can access the shared libraries. For example,
102 in the above case, you would need to add
103
104 export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:~/ascroot/lib
105
106 ------
107 INSTALLING ON WINDOWS
108
109 To build a Windows installer (a 'setup.exe') for the PyGTK GUI,
110 you will need to have the NSIS installer-creator installed on
111 your system (which is free, at http://nsis.sf.net/). Then you
112 should simply need to type
113
114 scons installer
115
116 This will leave an installer package named 'ascend-setup.exe'
117 in the pygtk/interface directory.
118
119 ------
120 CREATING AN RPM/DEB PACKAGE
121
122 Many users prefer to keep their systems clear of unpackaged
123 software. For this reason, we aim to provide the ability to build
124 ASCEND as an RPM package. There is a "SPEC" file included in the
125 source tree. If you have a source package, such as for example
126 ascend-NNNNN.tar.bz2, place it in your home directory, then
127 type the following
128
129 rpmbuild -ta ascend-NNNNN.tar.bz2
130
131 This will pull out the 'spec' from from the source package,
132 which hopefully will be up to date in correspondance with the
133 package version number NNNNN.
134
135 You will then be able to install ASCEND using something like
136
137 rpm -i ~/rpm/ascend-NNNNN-0.jdpipe.i386.rpm
138
139 Debian/Unbuntu users should find that they can create a usable
140 .deb package using the tool 'alien'. We haven't got native
141 support for the generation of .deb packages at this stage.
142
143 NOTE: occasionally the 'ascend.spec' file may need to be updated
144 if changes have been made to the 'ascend.spec.in' file. Check
145 the implementation details in the SConstruct file.
146
147 ------
148 GETTING SUPPORT AND FURTHER INFORMATION
149
150 For support with ASCEND, details of mailing lists and other
151 useful information, please visit
152
153 ASCEND user's website:
154 http://ascend.cheme.cmu.edu/
155
156 ASCEND developer's wiki:
157 https://pse.cheme.cmu.edu/wiki/view/Ascend/WebHome

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