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 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

More details to come here. For the PyGTK GUI, you can install
ASCEND by running the 'create.nsi' script (using the NSIS
installer-creator from http://nsis.sf.net/ which is free)
then running the created installation package.

------
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 
SCons as an RPM package. If you are in your home directory, type

    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.

------
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 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	More details to come here. For the PyGTK GUI, you can install
63	ASCEND by running the 'create.nsi' script (using the NSIS
64	installer-creator from http://nsis.sf.net/ which is free)
65	then running the created installation package.
66
67	------
68	CREATING AN RPM/DEB PACKAGE
69
70	Many users prefer to keep their systems clear of unpackaged
71	software. For this reason, we aim to provide the ability to build
72	SCons as an RPM package. If you are in your home directory, type
73
74	rpmbuild -ta ascend-NNNNN.tar.bz2
75
76	This will pull out the 'spec' from from the source package,
77	which hopefully will be up to date in correspondance with the
78	package version number NNNNN.
79
80	You will then be able to install ASCEND using something like
81
82	rpm -i ~/rpm/ascend-NNNNN-0.jdpipe.i386.rpm
83
84	Debian/Unbuntu users should find that they can create a usable
85	.deb package using the tool 'alien'. We haven't got native
86	support for the generation of .deb packages at this stage.
87
88	------
89	GETTING SUPPORT AND FURTHER INFORMATION
90
91	For support with ASCEND, details of mailing lists and other
92	useful information, please visit
93
94	ASCEND user's website:
95	http://ascend.cheme.cmu.edu/
96
97	ASCEND developer's wiki:
98	https://pse.cheme.cmu.edu/wiki/view/Ascend/WebHome