/[ascend]/trunk/debian/ascend.man
ViewVC logotype

Diff of /trunk/debian/ascend.man

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1573 by jpye, Wed Apr 25 04:30:36 2007 UTC revision 1574 by jpye, Sun Aug 5 03:52:55 2007 UTC
# Line 5  ascend \- A modelling environment for so Line 5  ascend \- A modelling environment for so
5  .SH SYNOPSIS  .SH SYNOPSIS
6  .B ascend  .B ascend
7    
8  Usage: ascend [[-m typename] file  Usage: ascend [[-m typename] FILE]
9    
10  Options:  Options:
11    --version             show program's version number and exit    --version     Show program's version number and exit.
12    -h, --help            show this help message and exit    -h, --help    Show this help message and exit.
13    -m MODEL, --model=MODEL    -m MODEL, --model=MODEL
14                          specify the model to instantiate upon loading modules                  Specify the model to instantiate upon loading modules
15    --pygtk-assets=ASSETS_DIR    --pygtk-assets=ASSETS_DIR
16                          override the configuration value for the location of                  Override the configuration value for the location of
17                          assets required by PyGTK for the ASCEND GUI, optional                  assets required by PyGTK for the ASCEND GUI, optional
18    --library=LIBRARY_PATH    --library=LIBRARY_PATH
19                          override the configuration value for the library path                  Override the configuration value for the library path
20    --no-auto-sim         disable auto-instantiation of MODEL named as the file    --no-auto-sim
21                          stem                  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  .SH DESCRIPTION
29    
30  \fbascend\fR will run the ne PyGTK GUI for ASCEND. It gives console output  \fBascend\fR will run the new PyGTK GUI for ASCEND. It gives console output
31  as well as using a GTK window.  as well as using a GTK window.
32    
33  \fBASCEND\fR (or \fBascend\fR) is modelling program that allows you  \fBASCEND\fR (or \fBascend\fR) is modelling program that allows you
# Line 30  to solve systems of equations. You write Line 35  to solve systems of equations. You write
35  your system of equations, then you load them into the ASCEND GUI and examine  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  and solve your equations. For more information see the ASCEND wiki at
37    
38  http://ascendwiki.cheme.cmu.edu/  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      

Legend:
Removed from v.1573  
changed lines
  Added in v.1574

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