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

Annotation of /trunk/INSTALL.txt

Parent Directory Parent Directory | Revision Log Revision Log


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

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