trunk/debian/ascend.man

.TH ASCEND 1 "April 21, 2007" ascend "User's Manual"
.SH NAME
ascend \- A modelling environment for solving equations

.SH SYNOPSIS
.B ascend

Usage: ascend [[-m typename] FILE]

Options:
  --version     Show program's version number and exit.
  -h, --help    Show this help message and exit.
  -m MODEL, --model=MODEL
                Specify the model to instantiate upon loading modules
  --pygtk-assets=ASSETS_DIR
                Override the configuration value for the location of
                assets required by PyGTK for the ASCEND GUI, optional
  --library=LIBRARY_PATH
                Override the configuration value for the library path
  --no-auto-sim
                Disable auto-instantiation of MODEL named as the file
                stem.
  FILE          Path to the .a4c or .a4l file that you want to open
                (note: if the path is not an absolute path and can
                not be located relative to the current directory, it
                will be seached for in the ASCEND model library path.

.SH DESCRIPTION

\fBascend\fR will run the new PyGTK GUI for ASCEND. It gives console output
as well as using a GTK window.

\fBASCEND\fR (or \fBascend\fR) is modelling program that allows you
to solve systems of equations. You write model files (*.a4c) that describe
your system of equations, then you load them into the ASCEND GUI and examine
and solve your equations. For more information see the ASCEND wiki at

http://ascend.cheme.cmu.edu/

.SH ENVIRONMENT

A number of environment variables are available for \fBascend\fR:

ASCENDLIBRARY          
  Path to ASCEND model files and external libraries.

ASCENDSOLVERS
  Path to ASCEND solvers. When searching for solvers, this path
  variable is used first, then ASCENDLIBRARY is searched next as
  a fallack, and in order to allow users to use solvers stored in
  their user-configured model folder.

CONOPT_PATH
  Path to libconsub3.so, if you have it. Usually defaults to /usr/lib if
  not defined.

.SH USER SETTINGS

ASCEND's PyGTK GUI uses a file ~/.ascend.ini to set and store user
preferences. This file includes a setting for the value of ASCENDLIBRARY
that is used if the variable is not present in the environment.

Also kept in the .ascend.ini file are details about preferred units of
measurement, and the most recent File..Open path, and the current
Solver selection. More things will be stored in .ascend.ini over time.


1	.TH ASCEND 1 "April 21, 2007" ascend "User's Manual"
2	.SH NAME
3	ascend \- A modelling environment for solving equations
4
5	.SH SYNOPSIS
6	.B ascend
7
8	Usage: ascend [[-m typename] FILE]
9
10	Options:
11	--version Show program's version number and exit.
12	-h, --help Show this help message and exit.
13	-m MODEL, --model=MODEL
14	Specify the model to instantiate upon loading modules
15	--pygtk-assets=ASSETS_DIR
16	Override the configuration value for the location of
17	assets required by PyGTK for the ASCEND GUI, optional
18	--library=LIBRARY_PATH
19	Override the configuration value for the library path
20	--no-auto-sim
21	Disable auto-instantiation of MODEL named as the file
22	stem.
23	FILE Path to the .a4c or .a4l file that you want to open
24	(note: if the path is not an absolute path and can
25	not be located relative to the current directory, it
26	will be seached for in the ASCEND model library path.
27
28	.SH DESCRIPTION
29
30	\fBascend\fR will run the new PyGTK GUI for ASCEND. It gives console output
31	as well as using a GTK window.
32
33	\fBASCEND\fR (or \fBascend\fR) is modelling program that allows you
34	to solve systems of equations. You write model files (*.a4c) that describe
35	your system of equations, then you load them into the ASCEND GUI and examine
36	and solve your equations. For more information see the ASCEND wiki at
37
38	http://ascend.cheme.cmu.edu/
39
40	.SH ENVIRONMENT
41
42	A number of environment variables are available for \fBascend\fR:
43
44	ASCENDLIBRARY
45	Path to ASCEND model files and external libraries.
46
47	ASCENDSOLVERS
48	Path to ASCEND solvers. When searching for solvers, this path
49	variable is used first, then ASCENDLIBRARY is searched next as
50	a fallack, and in order to allow users to use solvers stored in
51	their user-configured model folder.
52
53	CONOPT_PATH
54	Path to libconsub3.so, if you have it. Usually defaults to /usr/lib if
55	not defined.
56
57	.SH USER SETTINGS
58
59	ASCEND's PyGTK GUI uses a file ~/.ascend.ini to set and store user
60	preferences. This file includes a setting for the value of ASCENDLIBRARY
61	that is used if the variable is not present in the environment.
62
63	Also kept in the .ascend.ini file are details about preferred units of
64	measurement, and the most recent File..Open path, and the current
65	Solver selection. More things will be stored in .ascend.ini over time.
66
67
68
69