Section 3
Section 3
9)
Conceptually the basic network model has seven main “functions” (in addition to a
wide range of supplementary network programs plus matrix manipulation), the first
three of which are concerned with getting traffic flows onto the network, and the
last four more generally with the analysis of loaded networks.
The Network Build program, SATNET, which checks network data input and
sets up the files required by:
The Assignment, SATEASY, which assigns traffic on the basis of the delays
given by the simulation.
The network general analysis and plot program P1X which displays link-
based data either to a terminal or on a hard-copy device (and includes
virtually all the functions contained in the following three original programs).
The data base analysis program SATDB which allows an essentially free-
format manipulation and display of data.
Figure 3.1 and Figure 3.2 illustrate the inter-relationships of these functions
represented by discrete programs. Programs are enclosed by boxes and the files
passed between the programs and/or inputs to them are also indicated. Section
3.3 describes the file name conventions.
How to create the trip matrix file to be assigned, trips.ufm in Figure 3.1 and Figure
3.2, is dealt with in Section 4.
SATNET checks all input data, outputs error messages and sets up the internal
structural networks as required by (a) the simulation and (b) the assignment. The
precise structure of these networks or of the .uf* files which are passed between
programs need not concern the normal user; a general description is given in
Section 5. Data format specifications are given in Section 6.
The flows generated by the assignment model are then returned to the simulation
model which in turn re-calculates junction delays for re-input to the assignment.
The resulting iterative procedure is illustrated in Figure 3.1. While in principle the
loop can begin with either a simulation using default flow values or an assignment,
using default flow-delay relationships, in practice it is found to be better to start
with the assignment. The procedure terminates when the re-assignment of traffic
In the case of “buffer-only” networks, i.e., networks coded without any simulation
network (see 5.3), it is not necessary to run the simulation, in which case
convergence is reached by running the assignment once and proceeding directly
to the analysis programs.
Apart from the iterative loops between the simulation and assignment stages there
are also internal iterative loops within both stages which need to converge.
Generally speaking users should allow a sufficient number of internal iterations
(as governed by the parameters NITA and NITS described in 6.3) for the
individual programs to converge.
The analysis programs P1X etc. (see Section 11) enable users to examine output
from the assignment or simulation using interactive commands.
In addition PIX/PMAKE also provides for on-line network editing. While not
shown in Figure 3.1 there are two “feedback” loops from PIX. Firstly, a new
network data file suitable for input to SATNET may be produced by PIX by editing
existing network files. Secondly an edited version of the .ufs file may also be
produced and fed directly back to SATALL.
In older versions of SATURN (Figure 3.1) the analysis functions of P1X were
contained in four separate programs, P1, SATLOOK, SATDB and SATED. The
latter three still exist as distinct programs and in certain situations are best run in
that mode rather than within P1X.
Figure 3.1 – Running the Basic Saturn Model using SATALL; the current methodology
Figure 3.2 – Running the Basic SATURN Model using separate programs; the original
methodology
The input data to be prepared by the user consists of: (i) trip matrix data as
described in Section 4, and (ii) network data as described in Section 6.
Thus all data input, with the exception of saturation flows which require some
degree of “engineering judgment”, are well defined parameters which may be
obtained by relatively simple observation.
Buffer network data consists of link-based data only, e.g., as under (c) above.
Additional network-based data is also contained (optionally) within both GIS files
(see 5.6) and network X-files (see 6.13).
Users who wish to re-code existing networks and matrices to run on SATURN
should refer to Section 15.8.
Input/output files,
1
“Unformatted binary” vrs. “text” or “ascii”,
* As far as the normal user is concerned the essential difference between text and binary files is
that a text file may be created using the keyboard and/or viewed on the screen, (e.g., using a
Network data,
Trip matrices
Typically the name indicates the network/matrix/etc., and the extension indicates
the process/program which has produced that particular file.
Thus a network “named” LIVNET might spawn a number of files with extensions
such as LPA denoting the Line Printer output from the Assignment, UFS indicating
the “Unformatted” output from the Simulation, etc. etc. The documentation
assumes the DOS/WINDOWS “dot” convention, e.g. LIVNET.UFS.
3.3.2 Extensions
standard edit program such as Notepad), whereas a binary file is passed between programs and is
only “intelligible” to a program. Thus if you try to “type” a binary file on the screen you will get - at
best - gobbledygook and - at worst - a “stalled” computer. You have been warned !
KEY A “dummy” terminal file used to run an interactive program; see 14.5.1.
VDU A “dummy” terminal output file from an interactive program; see 14.5.1.
XY A supplementary node co
GIS A supplementary “Geographical Data” file; see 5.7.
MCC A supplementary file containing link counts.
BUS A supplementary file containing bus route data.
DBD A “Data Base Dump” file output/input by SATDB.
Conventionally, all the above files might be assigned the extension “.txt”, e.g. by a
word processor such as Microsoft Word.
All output line printer files have extensions “LP-” with the third letter/number
indicating the program that produced it as follows:
LPN SATNET
LPA SATEASY
LPS SATSIM
LPT SATALL
LPL SATLOOK
LPE SATED
LPP P1X
LPD SATDB
LPM SATME2
LPU SATU2
LPF SATOFF
LPC SATCH
LPX MX
The “standard” extensions above are used by the programs themselves to create
new files and/or to suggest extensions to the user on input. They are also
frequently used as a convenient shorthand to refer to files; e.g., the “LPN file”
would imply the line printer file produced by SATNET, a “DAT” file implies a
control file prepared by the user, etc. “UF files” refer in general to all UF*
unformatted files, while UFA/S refers to either UFA or UFS which may, in a
number of circumstances, be used interchangeably.
In addition there are a number of “system” files within the Suite itself which should
in some sense be inaccessible to users (i.e., they should not be accidentally
erased!). These will have conventional extensions as well as indicated below:
N.B. The extensions .DAT and .HLP are SATURN standards whereas extensions
such as .EXE and .BAT above are DOS standards; other operating systems will
therefore have their standard extensions for such files.
3.3.3 Pathnames
Every file has a full “pathname” associated with it. Thus the file net3.ufs on your
working directory may have the full name c:\SATURN\NEWTOWN\2005\net3.ufs.
In certain circumstances net3.ufs (or even net3 if SATURN expects the extension
.ufs) may be enough to identify it, in other circumstances the full pathname may
be required.
SATURN binary files store both filenames and pathnames and use both when
trying to open files.
PC versions of SATURN prior to 10.1 (9.5 and earlier) were all compiled as 16-bit
code which, in practical terms, meant that they needed to be run under MS-DOS
as opposed to “pure” MS Windows. Version 10.1 catered for both. By contrast
versions 10.2 and beyond are specifically designed for 32-bit applications and
may be run using the SATWIN Windows front-end program. Note, however that
the 32-bit versions may also be run under Command Prompt which may be
accessed through SATWIN.
The following two sections describe the two alternative methods in somewhat
general terms.
In order to run one program - or a linked set of programs - it is necessary for the
user to specify: (a) the program(s) and (b) the files to be used. Thus for every
individual program in the Suite there is a corresponding “procedure file” (e.g., a
.BAT file under DOS) with the same “name” as the program; e.g., SATLOOK.BAT.
Thus in order to run, say SATLOOK, the user types in “SATLOOK” followed by a
series of file names and/or key words. For example typing:
SATLOOK LIVNET
would run the program SATLOOK in order to analyse data for a “LIVNET”
network. To look at another network you would type:
SATLOOK EVERTON
The precise file to be analysed in the first case would be LIVNET.UFS, the
extension .UFS being implied. Output files are automatically created as
necessary with standard extensions as well. Thus the line printer output file
above would be LIVNET.LPL.
Note that simply typing the name of the program prints a brief “help file” to the
screen with instructions how to use that procedure:
In addition to .bat files that run individual programs there is also a set of “special
purpose” bat files (termed “batch procedures”, section 14.7) that perform specific
“one-off” functions. For example, the procedure SATCOST (15.27.4) uses the
program SATLOOK in order to produce a matrix of o-d costs. Similarly there are a
number of procedures based on the matrix manipulation program MX which, e.g.,
add two matrices together or factor a single matrix; see 10.20.
The big advantage of batch procedures is that they allow the user to run certain
standard “bread and butter” operations based on programs which are normally run
interactively but in a totally off-line or batch mode. In addition the user may then
create their own “super-bat” files which string together a sequence of calls to
individual .bat files in order to run a series of operations off-line (e.g., overnight).
Full instructions for running both styles of batch procedures are found in Section
14.
This section shows you how to install SATURN and, briefly, how to run the latest
version. In doing so, we introduce you to a new version of SATWIN, SATURN
Ten‟s User-friendly Interface.
SATURN 10.9 is the current release version and is the successor to all the
previous versions of SATURN. A much earlier release, 10.2, introduced the
(then) fairly revolutionary change to a 32-bit rather than a 16-bit suite; 10.3 to date
are straightforward evolutions in this respect. As a consequence, the latest
release builds on a strong existing base whilst offering significant enhancements;
see. the latest sub-section in Appendix D of the documentation for a full list of
changes.
As for earlier versions of SATURN Ten, a Windows style SETUP utility is supplied.
To install SATURN 10.7 load the CD and, if the CD does not auto-run the install
process, double-click on:
Setup.exe
You will be led through a series of install screens which will allow you either to
accept the standard folder setup or to select your own.
With the release of SATURN v10.9, the installation may also be undertaken using
the Microsoft Installer (ie .MSI) package – these are available on request
From SATURN 10.2 onwards, users may, if they prefer, install SATWIN under
\Program files\ rather than the default \satwin folder. This, and indeed installation
under any folder containing a space, was previously prohibited but this limitation
has now been corrected.
However, once a suitable home has been chosen, program executables and
assorted DLLs, bat and control files, help and PDF-based documentation will be
automatically installed on your hard disk. You can then run SATURN as
previously from a Command prompt (remembering to set the Path to the directory
chosen for EXE and BAT file, \SATWIN\XEXES\ by default and check preferences
in SAT10KEY.DAT), or to use SATWIN which can be accessed through the
desktop icon.
If you have a previous version of SATURN, this will be overwritten during the
installation process. However, users can keep previous versions of SATURN
(before installing the current version) by renaming the existing XEXES folder. This
could be renamed to say “XEXES 10.7.10” (where 10.7.10 indicates the version
number).
3.6.2 SATWIN
The File menu is used to exit from SATWIN, for consistency with other Windows-
based software.
SATWIN normally creates and updates some ASCII text files during use;
consequently, it needs to be able to write to the drive where it is installed as well
as to the drive (if different) where "Working Folders" are located.
To address this problem the user should ask the system administrator to provide
write-access to the folder where SATWIN is installed as well as "Working Folders"
or log in as administrator.
The Settings menu is used to select four standard folders where SATURN files
are stored
the “Program folder” where the .exe and .bat files etc. are stored,
These are set automatically to correspond to the folders set during installation,
either by default or by explicit choice. Any later changes made are “remembered”
by SATWIN the next time you use it.
The latter three folders probably never need to be re-set once they have been
initialised for your installation. However the first “working” folder, which defines
the folder from where, by default, current data files are selected, tends to be
changed frequently as users shift between different projects. The current working
folder is displayed on the main SATWIN screen at all times.
From the main screen (see below), select Module Run using the mouse, followed
by “SATURN” and the selection of a specific module:
Once files have been selected, click on Run and the module executes. Upon
completion you have the option to view the output LP file or to run further
modules.
You can also run modules directly from the Events log in one of three ways:
1) Click and existing command in the Events log to highlight it, then press the
F2 or Insert key to enter Edit mode, then type a new command or edit the
existing command and press the ENTER key to stop editing. (Alternatively,
click the command to highlight it, then click it again to enter Edit mode.
Note that this is not the same as double-click, there is a pause between
clicks).
2) Click the entry <Click Here To Select, Then Press F2 Key or Click
Again To Enter A New Command> in the Events Log to highlight it, then
press the F2 or Insert key to enter Edit mode, then type a new command
and press the ENTER key to stop editing. Alternative is similar to option 1
above.
3) Drag a batch file (from the Desktop, Windows Explorer, etc.) and drop it on
the Events log.
4) After entering a command you can Double-click it, click the Run Items(s)
button, or press the F4 key to run it
Note: the Events Log now indicates the Program Folder (see below, fourth
column) containing the version of SATURN used to execute a command (in
addition to the Working Folder where data files reside, see below third
column).
The first command SATNET CNET uses CNET data file from “Working
Folder” C:\SATWIN\TEST\CORDONSRN and SATNET v10.8.22 from
“Program Folder” C:\SATWIN\XEXES 10.8.22.
The second command SATURN LIV10 LIVTRIPS uses data files from
“Working Folder” C:\SATWIN\TEST and SATURN (i.e. SATNET/SATALL
v10.8.22) from “Program Folder” C:\SATWIN\XEXES 10.8.22.
The third command SATURN LIV10 LIVTRIPS uses data files from “Working
Folder” C:\SATWIN\TEST and SATURN (i.e. SATNET/SATALL v10.9.10)
from “Program Folder” C:\SATWIN\XEXES 10.9.10.
The last entry in the Event Log indicate the current “Working Folder” (i.e.
D:\TEMP\SATURN MULTI-CORE\DMB312) and “Program Folder” (i.e.
C:\SATWIN\XEXES 10.8.22. This means that any commands issued within
SATWIN will use data files and SATURN modules from the respective folders.
You can change “Working Folder” and “Program Folder” at any time via the
Settings/Folders menu option.
The “Batch Run” menu option may be used to prepare, edit and execute a number
of modules in sequence. This is done using the ‟Batch Run Setup‟ Dialog box as
shown below.
Double-clicking a SATURN module category from the displayed list will reveal the
available modules, a subsequent click to the module will select it. The “Set Module
Parameters” and “Module Help” buttons will also be enabled.
Resting the mouse button inside the box with the list of SATURN modules will
provide a one line description of the selected module.
Clicking the “Set Module Parameters” button will set the required parameters for
the selected module with the “Module Help” button provide additional supporting
information on that module.
After setting the module parameters, the command line will be displayed in the
editable batch file contents box. Further modules may be manually added to the
batch file contents text box.
The „Run‟ button will start the the module(s) in the batch file contents text box
whilst the „Save‟ button will save the contents to a batch file for later re-use. The
„Edit‟ button will open the batch file in Notepad and the „Clear‟ button to remove
information from the text box.
Previously created batch files may also be used by selecting via the “Select Other
Batch Files” button.
Note: instead of using the Batch Run menu, you may also drag batch files or the
SATURN executables (from Windows Explorer) and drop them into the Events log
to run them automatically.
SATURN commands can be typed directly into the command line box or individual
modules and input files may be selected from pull down menus using the Select
Command and Select Parameter buttons respectively. This approach can be used
for interactive runs of modules e.g. MX I
To get help on supported DOS commands, press the F2 key on the keyboard.
Help on a selected SATURN command is automatically displayed on a side box to
the right of the Command Line dialog box. Using the Hide button will conceal the
help box. Pressing the F2 key after selecting a command will display the
command‟s help information in a separate Help dialog box. You can press the
up/down arrow keys on the keyboard to step through previous commands if the
cursor is on the command entry box or use the „Previous Commands‟ button to
display the list of previously used commands.
Possibly the first thing you would want to do on loading SATURN and SATWIN
would be to run the test network.
Choosing a test network from the Test Network menu presents you with the Test
Run Template below corresponding to the network.
Test Network 1 will run MXM1 to build trip matrix HAT, followed by SATNET,
SATALL and P1X for network HEADE, leaving you in P1X interactive mode.
Upon exit from P1X, the following screen will allow you to view any of the LP files
generated
Test Network 2 will run SATNET, SATALL and P1X for network N10, leaving you
in P1X interactive mode, which in this example will show a background bitmap of
the network.
SATWIN also allows access to Notepad editor or a command line prompt through
the toolbar as below.
If the full or demo version of DRACULA is included with SATURN, the menu
option DRACWIN will appear on the SATWIN menu bar (see above). This
provides access to DRACULA through its front-end program DRACWIN.
SATURN modules (or other modules for PT-SATURN and DRACULA if installed)
may be accessed by right-clicking on the event log.
When several runs are displayed on the event log, you can delete selected runs.
The options are available to remove all commands in the log or a set of cursor
selected commands. Individual commands can also be deselected as above.
You can also select modules or commands from the event log and run them in
batch mode. Simply hold down the CTRL key, click the modules you wish to run in
batch mode, then click Run Item(s) or press the F4 key. You will have the option
to save your selection as a batch file before the run proceeds. This provides the
opportunity to be able to re-run the batch file again later if necessary.
Double-click the Working Folder display bar to change folders. You can also type
in or copy and paste a folder in the folder display bar.
SATWIN uses NotePad or WordPad to view LP files by default. You may specify a
different default editor by clicking Set Default Editor from Settings menu. The
default editor is used automatically when viewing LP files through SATWIN. The
editor can be accessed through the Tools menu
An Index to and Individual Chapters from the SATURN User Guide can also be
accessed directly from SATWIN.
SATWIN from version 10.3 of SATURN has also been designed to perform as an
integrated front-end for a range of transport planning software including not only
SATURN, but also DRACULA and PT-SATURN. The DRACULA Demonstration
is now integrated with the release of SATURN and access to the full program will
be through SATWIN. Similarly, PT-SATURN modules will execute in the same
way as those from SATURN.
SATURN version information can be found on the bottom left of SATWIN window
as illustrated below.
Detailed SATURN version information (shown in the dialog box below) is available
through “SATURN Version Info” from the Help menu or by double-clicking the
version information area indicated above.
If the user wishes to Detailed SATURN version information (shown in the dialog
box below) is available through “SATURN Version Info” from the Help menu or by
double-clicking the version information area indicated above.
If “Version Unknown” appears in the selection box, SATWIN was unable to identify
the specific version (eg a version of SATURN previously installed under the
XEXES directory).
The reference to the “SATURN Version Unknown” may be removed by the user
by:
Determining the SATURN version and level in use. This may be readily
achieved by viewing any output Line Printer file using the executables – the
version and level in use will be reported at the top of the file (eg Version
„10.5.12‟ and Level „N3‟); and
Creating a new text file called “SATURN.VER”, in the same directory as the
executables, containing at least one line of text that says “SATURN <version>
Level <level>” – for example “SATURN v10.5.12 Level N3”
Access to other non-SATURN (user) programs from the SATURN DOS Command
Shell is possible by specifying the full paths containing the user programs via
“SATURN DOS Command Shell Paths” from the Settings menu.
This will bring up the dialog box below. You can add paths containing other
programs you wish to have access to in the “Paths Containing User Programs”
text box by copy and paste or selecting a path through “Add Path” button.
You can access the previous 15 commands issued on the Events Log via the File
menu.
The list can be cleared via the “Settings/Clear Recent Command List” menu
option
Select the commands you wish to save from the Events Log, then click “Save
Item(s)” button on the Toolbar or “Save EventLog” from the File menu. The
commands are saved to a file you specify with the file extension .CMD. If you click
“Save Item(s)” without selecting a command, all the commands currently on the
Events Log will be saved.
To use previously saved commands, load an Events Log file via “File/Open
Eventlog File” menu option or drag and drop the file onto the Events Log.
When file association is active, double-clicking on a UFS or UFM file for example
will automatically open the file with P1X and MX respectively.