Contents of /trunk/INSTALL

BUILDING AND INSTALLING ASCEND

Thanks for downloading ASCEND! We hope you'll find it straight-
forward to set up and run ASCEND. If you have any comments on
your experience with this, we're very keen to hear about that.
Please check out the up-to-date contact details at:
https://pse.cheme.cmu.edu/wiki/view/Ascend/WebHome

There are older versions of this document, which include instructions
on how to build ASCEND with GNU Autotools. This may or may not work
with the version you are currently looking at.
https://pse.cheme.cmu.edu/svn-view/ascend/code/trunk/INSTALL?view=log

-----
BUILDING ON LINUX AND WINDOWS

To build ASCEND we now recommend using SCons. This is supported
both on Windows (using the MinGW toolset) and Linux. Their fans
will also find build tools for jam and autotools. The autotools
build is still maintained for at least the tcl/tk interface version.

ASCEND provides two possible interfaces. The older, more mature
GUI is based on Tcl/Tk. A newer interface that is more in keeping
with modern GUI design is implemented using PyGTK, but it is still
missing some functionality.

Using SCons 0.96.91 or newer, see your build options by typing

    scons -Qh

You can add your build options to a file in this directory
which you can create, called 'config.py'.

Then to build ASCEND, type

    scons

SCons will tell you what version(s) of ASCEND it is able to build.
The PyGTK interface requires Python (which is present if you have
SCons). The Tcl/Tk interface requires that you have Tcl/Tk and
TkTable installed on your system.

For updates on this information, please check
https://pse.cheme.cmu.edu/wiki/view/Ascend/BuildingAscend

For specific information on building the Python interface and
setting up the PyGTK GUI, please see
https://pse.cheme.cmu.edu/wiki/view/Ascend/PythonWrapper

------
INSTALLING ON LINUX

To then install ASCEND, you will need to have write access to the 
directories INSTALL_DATA, INSTALL_BIN as specified in your
SCons configuration. You can then type

    scons install

------
INSTALLING ON WINDOWS

To build a Windows installer (a 'setup.exe') for the PyGTK GUI,
you will need to have the NSIS installer-creator installed on
your system (which is free, at http://nsis.sf.net/). Then you 
should simply need to type

    scons WITH_INSTALLER=1

This will leave an installer package named 'ascend-setup.exe'
in the pygtk/interface directory.

------
CREATING AN RPM/DEB PACKAGE

Many users prefer to keep their systems clear of unpackaged
software. For this reason, we aim to provide the ability to build 
ASCEND as an RPM package. There is a "SPEC" file includes in the
source tree. If you have a source package, such as for example
ascend-NNNNN.tar.bz2, place it in your home directory, then
type the following

    rpmbuild -ta ascend-NNNNN.tar.bz2

This will pull out the 'spec' from from the source package, 
which hopefully will be up to date in correspondance with the
package version number NNNNN.

You will then be able to install ASCEND using something like

    rpm -i ~/rpm/ascend-NNNNN-0.jdpipe.i386.rpm

Debian/Unbuntu users should find that they can create a usable
.deb package using the tool 'alien'. We haven't got native
support for the generation of .deb packages at this stage.

NOTE: occasionally the 'ascend.spec' file may need to be updated
if changes have been made to the 'ascend.spec.in' file. Check
the implementation details in the SConstruct file.

------
GETTING SUPPORT AND FURTHER INFORMATION

For support with ASCEND, details of mailing lists and other
useful information, please visit

ASCEND user's website:
http://ascend.cheme.cmu.edu/

ASCEND developer's wiki:
https://pse.cheme.cmu.edu/wiki/view/Ascend/WebHome
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	INSTALLING ON LINUX
52
53	To then install ASCEND, you will need to have write access to the
54	directories INSTALL_DATA, INSTALL_BIN as specified in your
55	SCons configuration. You can then type
56
57	scons install
58
59	------
60	INSTALLING ON WINDOWS
61
62	To build a Windows installer (a 'setup.exe') for the PyGTK GUI,
63	you will need to have the NSIS installer-creator installed on
64	your system (which is free, at http://nsis.sf.net/). Then you
65	should simply need to type
66
67	scons WITH_INSTALLER=1
68
69	This will leave an installer package named 'ascend-setup.exe'
70	in the pygtk/interface directory.
71
72	------
73	CREATING AN RPM/DEB PACKAGE
74
75	Many users prefer to keep their systems clear of unpackaged
76	software. For this reason, we aim to provide the ability to build
77	ASCEND as an RPM package. There is a "SPEC" file includes in the
78	source tree. If you have a source package, such as for example
79	ascend-NNNNN.tar.bz2, place it in your home directory, then
80	type the following
81
82	rpmbuild -ta ascend-NNNNN.tar.bz2
83
84	This will pull out the 'spec' from from the source package,
85	which hopefully will be up to date in correspondance with the
86	package version number NNNNN.
87
88	You will then be able to install ASCEND using something like
89
90	rpm -i ~/rpm/ascend-NNNNN-0.jdpipe.i386.rpm
91
92	Debian/Unbuntu users should find that they can create a usable
93	.deb package using the tool 'alien'. We haven't got native
94	support for the generation of .deb packages at this stage.
95
96	NOTE: occasionally the 'ascend.spec' file may need to be updated
97	if changes have been made to the 'ascend.spec.in' file. Check
98	the implementation details in the SConstruct file.
99
100	------
101	GETTING SUPPORT AND FURTHER INFORMATION
102
103	For support with ASCEND, details of mailing lists and other
104	useful information, please visit
105
106	ASCEND user's website:
107	http://ascend.cheme.cmu.edu/
108
109	ASCEND developer's wiki:
110	https://pse.cheme.cmu.edu/wiki/view/Ascend/WebHome