SATURN MANUAL (V11.3)
The Basic SATURN Model
3.
The Basic SATURN Model
INTRODUCTION
3.1
The Network Model Structure
3.1.1
The SATURN Network Modules
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.
Originally each “function” was contained within a single program or module.
However in more recent versions (9.3 and beyond) the basic “functions” are
aggregated into single very large programs such as SATALL and PIX below that
carry out a wide range of functions.
Those which deal with loading traffic are:
♦
the Network Build program, SATNET, which checks network data input and
sets up the files required by:
♦
the combined simulation-assignment program SATALL whose functions were
originally provided by two separate programs:
♦
the Assignment, SATEASY, which assigns traffic on the basis of the delays
given by the simulation.
♦
the Simulation, SATSIM, which models in detail the passage of traffic through
the network and the resulting delays.
The ‘analysis’ and display programs comprise:
♦
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 analysis program, SATLOOK, which enables a detailed description of
traffic conditions to be printed in text format.
♦
the node editing program SATED which allows nodes to be simulated on an
individual basis using interactive commands.
♦
the data base analysis program SATDB which allows an essentially freeformat 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.
5120257 / Mar 14
Section 3.docx
3-0
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.1.2
The Iterative Structure
A single ‘run’ of SATURN to achieve a loaded network will usually be
accomplished by a single call to a SATURN control file (see 14.3). Parameters
are used to indicate the network and (optionally) trip matrix file names; e.g.
SATURN Netname Tripname
This causes the network build module SATNET to be activated followed by
SATALL to perform the assignment and simulation functions, as illustrated in
Figure 3.1.
Historically SATURN made use of an automatic loop between two separate
programs SATASS (or SATEASY) and SATSIM (Figure 3.2) and this may still be
done - although not recommended in normal circumstances. The choice of the
external or internal loop is dictated by the procedure used: SATURN and
SATURN9 use SATALL, SATURN8 uses the explicit loop. See Sections 9.1 and
14.3.
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 primary objective of the simulation is to determine junction delays resulting
from a given pattern of traffic. A general description of the assumptions made and
the procedures followed is given in Section 8. The information on delays is input
to the assignment which selects appropriate routes through the network for each
element in the trip matrix, bearing in mind relationships between travel time and
flow as determined by the simulation. By default the model uses an ‘equilibrium’
technique based on an optimum combination of all-or-nothing assignments, so
that for a given O-D pair a range of routes is normally used but each has the same
minimum O-D cost. Alternative assignment techniques, e.g., all-or-nothing, Burrell
multiple-route, may also be used. Section 7 provides details.
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
is sufficiently small or a (user-specified) maximum number of iterations (MASL) is
exceeded. Normally the sequence concludes with a run of the simulation.
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
5120257 / Mar 14
Section 3.docx
3-1
SATURN MANUAL (V11.3)
The Basic SATURN Model
(as governed by the
e parameters NITA and NITS described in 6.3) for the
individual programs to
o converge.
c
3.1.3
The Analysis and Disp
isplay of Results
The analysis programs
s P1X etc. (see Section 11) enable users to ex
examine output
from the assignment or simulation using interactive commands.
In addition P1X/PMAK
AKE also provides for on-line network editing
ing. While not
shown in Figure 3.1 there
th
are two “feedback” loops from P1X. F
Firstly, a new
network data file suitab
able for input to SATNET may be produced by P
P1X by editing
existing network files.
s. Secondly an edited version of the .ufs file
ile may also be
produced and fed direct
ectly back to SATALL.
In older versions of SATURN
S
(Figure 3.1) the analysis functionss of P1X were
contained in four separ
arate programs, P1, SATLOOK, SATDB and
d SATED. The
latter three still exist as distinct programs and in certain situations a
are best run in
that mode rather than within
w
P1X.
Figure 3.1 – Running the Basic
ic Saturn Model using SATALL; the currentt m
methodology
5120257 / Mar 14
Section 3.docx
3-2
SATURN MANUAL (V11.3)
The Basic SATURN Model
Figure 3.2 – Running the Basic
ic SATURN Model using separate programs;
s; the original
methodology
3.2
Data Requirements
The input data to be
e prepared by the user consists of: (i) trip m
matrix data as
described in Section 4, and (ii) network data as described in Section
n6
6.
Simulation network data
ata requirements may be summarised as follows
ws:
5120257 / Mar 14
Section 3.docx
a)
Universal param
meters such as minimum gap acceptance, etc;
c;
b)
Junction data - type
t
of junction (signals/priority/roundabout);; cco-ordinates;
c)
Link data - dista
istance, time or speed, number of lanes, stac
acking capacity
(optional);
d)
sa
flow, lanes available, a priority mar
arker indicating
Turn data - a saturation
give ways, etc;
3-3
SATURN MANUAL (V11.3)
The Basic SATURN Model
e)
Traffic signal data - stage lengths; offsets; cycle time
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.
3.3
File Name Conventions
Running SATURN programs involves the creation and manipulation of a large
number of files. This section describes a recommended standard method for
handling file names
3.3.1
General Principles
Files may be classified in a number of different ways; e.g. by their computerbased characteristics
♦
Input/output files,
♦
“Unformatted binary” vrs. “text” or “ascii”,
♦
Scratch/permanent or by function-based characteristics such as
♦
Network data,
♦
Trip matrices
1
The filename conventions should try to reflect these differences.
File names differ considerably between different computers and different
operating systems. SATURN follows standard DOS and WINDOWS conventions
whereby every file must have
♦
a “name” (or, more generally, a “pathname”, see 3.3.3 below)
♦
and an “extension” (with a maximum of 3 characters)
Typically the name indicates the network/matrix/etc., and the extension indicates
the process/program which has produced that particular file.
*
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
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!
5120257 / Mar 14
Section 3.docx
3-4
SATURN MANUAL (V11.3)
The Basic SATURN Model
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
The following rules govern the standard or “default” files extensions:
All unformatted binary files have extensions beginning with UF. In particular:
UFN
An unformatted file output (only) by SATNET
UFS
An unformatted file produced by SATSIM or SATALL
UFA
“
UFM
An unformatted matrix file
UFP
A file containing “pija” factors as passed from SATPIJA to SATME2
UFT
An unformatted file output by SATSUMA; see 17.5
UFX
Scratch files.
UFC
An unformatted file of costs used to re construct routes see 15.23.
“
“
“
SATEASY
“Text” files used as control or data files:
DAT
All basic data or control files created by the user, e.g., using a text editor such
as Notepad or Wordpad (not MS Word) and used as input
KP
A “card punch” file output by a program.
HLP
Help files used by all interactive programs.
LOG
A file containing a list of all terminal input commands from the run of an
interactive program; see 14.5.1.
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:
5120257 / Mar 14
Section 3.docx
LPN
SATNET
LPA
SATEASY
3-5
SATURN MANUAL (V11.3)
The Basic SATURN Model
LPS
SATSIM
LPT
SATALL
LPL
SATLOOK
LPG
SATPIG
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:
♦
FORTRAN source code files
♦
Executable code files (.EXE files)
♦
Procedures to run programs (.BAT files)
♦
Basic data files (.DAT files)
♦
Help files (Extension .HLP)
♦
Salford library files (Extension .DLL)
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.
5120257 / Mar 14
Section 3.docx
3-6
SATURN MANUAL (V11.3)
The Basic SATURN Model
SATURN binary files store both filenames and pathnames and use both when
trying to open files.
Path/filenames may contain up to 256 characters. (Versions prior to 10.1 were
limited to 96.)
3.4
32-Bit SATURN Versions
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.
3.5
Running Programs Under DOS (or Command Prompt)
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).
5120257 / Mar 14
Section 3.docx
3-7
SATURN MANUAL (V11.3)
The Basic SATURN Model
Full instructions for running both styles of batch procedures are found in Section
14.
3.6
Running Programs under WINDOWS: SATWIN10 and SATWIN11
This section shows you how to install SATURN and, briefly, how to run the latest
version via SATWIN 10, SATURN Ten’s User-friendly Interface or the newer
SATWIN11.
SATURN 11.3 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 per release version.
3.6.1
The SATURN Install Procedures
As for earlier versions of SATURN Ten, a Windows style SETUP utility is supplied.
To install SATURN 11.3 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 SATWIN10 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 SATWIN10 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).
If multiple versions of SATURN are detected when SATWIN10 is launched, the
dialog box below will appear, enabling you to select the version to use in the
current session.
5120257 / Mar 14
Section 3.docx
3-8
SATURN MANUAL (V11.3)
The Basic SATURN Model
From SATURN 11.2 onwards, the user also has the option to install the newer
SATWIN11 front-end in preference to SATWIN10 - SATWIN10 is described in
section 3.7 whilst information for SATWIN11 is available in section 3.8.
3.7
SATWIN10 User Interface
3.7.1
Overview
SATWIN10 is a front end for SATURN with six principle functions:
♦
to run a single Module, e.g., SATNET or P1X
♦
to set up a Batch run (to run modules successively)
♦
to run from a command line
♦
to run the test network
♦
to enable other standard Windows “tools” to be invoked
♦
to interactively access the Manual.
These are selected from the main screen as below
5120257 / Mar 14
Section 3.docx
3-9
SATURN MANUAL (V11.3)
The Basic SATURN Model
The File menu is used to exit from SATWIN, for consistency with other Windowsbased software.
3.7.1.1
SATWIN10 and Windows NT/2000/XP/Vista/7/8
If SATWIN10 is launched on a Windows NT (or later) when logged in as a user
without write-access to the drive where SATWIN10 is installed, the following error
could occur:
♦
Run-time error 75 - Path/File access error
SATWIN10 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 SATWIN10 is installed as well as "Working
Folders" or log in as administrator.
3.7.1.2
Setting Folders
The Settings menu is used to select four standard folders where SATURN files
are stored
5120257 / Mar 14
Section 3.docx
♦
the “working folder”,
♦
the “Program folder” where the .exe and .bat files etc. are stored,
3-10
SATURN MANUAL (V11.3)
The Basic SATURN Model
♦
the “Control Files folder” (e.g. SATALL0.DAT etc),
♦
the “Manual folder”.
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 SATWIN10 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 SATWIN10 screen at all times.
3.7.2
Running a Single Module
From the main screen (see below), select Module Run using the mouse, followed
by “SATURN” and the selection of a specific module:
A new module-specific template will be displayed allowing you to select the
necessary files. For example, if you select the module SATURN (which runs
SATNET followed by SATALL), the template allows you the basic selection of a
network .dat file and a matrix .ufm file as below plus, optionally, UPDATE and/or
PASSQ files.
5120257 / Mar 14
Section 3.docx
3-11
SATURN MANUAL (V11.3)
The Basic SATURN Model
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).
5120257 / Mar 14
Section 3.docx
3-12
SATURN MANUAL (V11.3)
The Basic SATURN Model
The image above for examples shows the following:
♦
The current “Working Folder” is D:\TEMP\SATURN MULTI-CORE\DMB312
♦
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.
3.7.3
Preparing a Batch Run
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.
5120257 / Mar 14
Section 3.docx
3-13
SATURN MANUAL (V11.3)
The Basic SATURN Model
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
5120257 / Mar 14
Section 3.docx
3-14
SATURN MANUAL (V11.3)
The Basic SATURN Model
‘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.
3.7.4
Running from Command Line
This is perhaps the nearest equivalent to running SATURN from a ‘traditional’
DOS-type command prompt.
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.
3.7.5
Running the Test Network
Possibly the first thing you would want to do on loading SATURN and SATWIN10
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.
5120257 / Mar 14
Section 3.docx
3-15
SATURN MANUAL (V11.3)
The Basic SATURN Model
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.
3.7.6
Other Tools
SATWIN10 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.
3.7.7
Other Features OF SATWIN10
3.7.7.1
Quick Access to Modules
SATURN modules may be accessed by right-clicking on the event log.
(if PT-SATURN or DRACULA is installed from previous versions of SATURN
these options will also appear in SATWIN 10)
5120257 / Mar 14
Section 3.docx
3-16
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.7.7.2
Selective Deletion of Event Log Runs
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.
3.7.7.3
Batch Runs from modules selected in Event Log
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.
3.7.7.4
Changing Working Folder
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.
5120257 / Mar 14
Section 3.docx
3-17
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.7.7.5
Editor of choice
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
3.7.7.6
SATURN Manual
An Index to and Individual Chapters from the SATURN User Guide can also be
accessed directly from SATWIN.
3.7.7.7
SATURN Version Information
SATURN version information can be found on the bottom left of SATWIN 10
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.
5120257 / Mar 14
Section 3.docx
3-18
SATURN MANUAL (V11.3)
The Basic SATURN Model
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 10 was unable to
identify the specific version (eg a version of SATURN previously installed under
the XEXES directory).
5120257 / Mar 14
Section 3.docx
3-19
SATURN MANUAL (V11.3)
The Basic SATURN Model
The reference to the “S
“SATURN Version Unknown” may be removed
ved by the user
by:
5120257 / Mar 14
Section 3.docx
♦
Determining the SATURN
S
version and level in use. This ma
may be readily
achieved by viewin
ing any output Line Printer file using the exec
ecutables – the
version and levell in use will be reported at the top of the file (eg Version
‘10.5.12’ and Level
vel ‘N3’); and
♦
Creating a new tex
text file called “SATURN.VER”, in the same dir
directory as the
executables, conta
taining at least one line of text that says “SATUR
URN <version>
Level <level>” – for example “SATURN v10.5.12 Level N3”
3-20
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.7.7.8
Using Other Programs from SATURN DOS Command Shell
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.
5120257 / Mar 14
Section 3.docx
3-21
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.7.7.9
Recent Event Log Commands
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
5120257 / Mar 14
Section 3.docx
3-22
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.7.7.10 Save Events Log Commands for Later Use
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.
3.7.7.11 SATURN File Associations
SATURN data files can be associated to SATURN modules including a
description of each file type when viewed in Windows Explorer via
“Settings/SATURN File Association” menu option. When active, a tick appears
next to the menu item. You can deactivate the association by clicking the menu
option.
Screen shot of a “Working Folder” C:\SATWIN\TEST in Windows Explorer with no
file association
5120257 / Mar 14
Section 3.docx
3-23
SATURN MANUAL (V11.3)
The Basic SATURN Model
Screen shot of a “Working Folder” C:\SATWIN\TEST in Windows Explorer with
SATURN file association.
5120257 / Mar 14
Section 3.docx
3-24
SATURN MANUAL (V11.3)
The Basic SATURN Model
LIV10L.UFS for example is described as “SATURN Loaded network binary file”
and is associated with P1X as indicated by icon. Unlike the description of UFS file
in screen shot without association.
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.
3.8
SATWIN11 User Interface
3.8.1
Overview
SATWIN11 provides an updated front end for SATURN, replacing the existing
time honoured SATWIN10 application.
SATWIN11 enables the user to undertake the following tasks:
♦
Easily access and discover categories of modules, e.g. Matrix Manipulation
or Conversion;
♦
Quick search for any module, e.g., SATNET or P1X by name or by keyword;
♦
Start a command prompt;
♦
Run the test networks;
♦
Starting standard Windows ’tools’;
♦
Access the SATURN Manual (either PDF or online);
♦
Manage error logs from SATNET; and
♦
Search for and launch your own Batch files.
SATWIN 11 also provides a new way of working with SATURN modules by
introducing a new concept of a ‘model-centric workspace’ called the ‘Model
Complex’.
3.8.2
The ‘Model Complex
A Model Complex can be saved, reopened and shared.
The Model Complex keeps track of the user’s working folders, the SATURN
version and their own tool folders (specifically batch files created by the user) as
well as keeping a log of the commands that have been executed while using the
given Model Complex.
At the end of a session the user will be asked if the user wishes to save changes
to the model complex – if they select ‘no’, the Model Complex will not be updated,
however any activity in the session will be saved in a last session log file that can
be opened next time SATWIN11 is used. This file is overwritten every time
SATWIN is closed.
5120257 / Mar 14
Section 3.docx
3-25
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.8.3
Running SATWIN11
3.8.3.1
Starting SATWIN (‘Quick Start’)
The first time SATWIN is started you will see the Quick Start menu prompting you
to:
1)
Restore the last session (using the auto saved session model complex
from the previous use)
2)
Open the last used Model Complex (will be different to above option if the
user did not save at the end of last session).
3)
Open an existing Model Complex. Let the user browse to a previously
saved Model Complex.
4)
Create a new Model Complex with default values (same as clicking X).
The user can tick a box to automatically start the next SATWIN session where it
was left on last exit. This will mean that the quick start menu is not displayed. This
setting can be changed in the Tools tab.
3.8.3.2
Setting Folders and Properties for the Model Complex
The user may specify a name and a description for their Model Complex
5120257 / Mar 14
Section 3.docx
3-26
SATURN MANUAL (V11.3)
The Basic SATURN Model
The Settings menu is also used to select two standard folders where SATURN
files are stored:
♦
Model Working Folder – used for specifying data locations; and
♦
Program Folder – the path for the.EXE and .BAT files related to the SATURN
version.
Two other folders are automatically updated:
♦
Control Files folder (e.g. SATALL0.DAT etc) is automatically configured as
the \DAT under the SATWIN 11 install directory,
♦
Manual Folder – automatically set to the \DOCS folder under the SATWIN 11
install directory,
These are defined during the initial installation routine either by default or by
explicit choice. Any later changes made are “remembered” by SATWIN 11 the
next time it is used.
The current working folder is displayed on the main SATWIN 11 screen at all
times as is the current SATURN version.
3.8.4
Running a Single Module
From the ‘Home’ tab, click SATURN to start that specific module or alternatively
use the Search box on the Home tab to find the module to be run:
5120257 / Mar 14
Section 3.docx
3-27
SATURN MANUAL (V11.3)
The Basic SATURN Model
A new module-specific
fic template will be displayed allowing the user
er to select the
necessary files. Forr example, if the module SATURN (which ru
runs SATNET
followed by SATALL) is selected, the template enables the user
er to select the
network .dat file and a matrix .ufm file as shown below (plus, optiona
nally, UPDATE
and/or PASSQ files iff re
required).
Once files have been selected,
se
click on Run and the module executes
tes.
Each Module paramete
eter window has options to keep the command
nd prompt open
and apply either Quick
ick and/or Quiet options. By default, the formss w
will remember
the previously selected
d files.
This behaviour may be changed – select the Tools  User Interf
terface  Clear
Parameters check box.
x. To clear the parameters, click the reset butto
tton.
5120257 / Mar 14
Section 3.docx
3-28
SATURN MANUAL (V11.3)
The Basic SATURN Model
All the Module Parameter forms have a feedback button allowing the user to share
their ideas with the SATURN development team via email. All the feedback
received will assist in the development of the future releases.
Upon completion of the module, the user has the option to view the output LP file
or to run further modules.
The user may need to refresh the file list before the newly created LP files are
available. To view the selected file in the user-defined text editor, click Show. To
review the errors in the Error Manager, click the exclamation icon.
3.8.4.1
Using the Command Log View to re-launch commands
The user may also run modules directly from the Command Log viewer by double
clicking an existing command in the list
To enter the Edit mode, right click on the Command Log entry  Edit Copy or 
Edit Task Description & Command Parameters. Then type a new command or
edit the existing command and press OK
The image above for examples shows the following:
5120257 / Mar 14
Section 3.docx
3-29
SATURN MANUAL (V11.3)
The Basic SATURN Model
♦
The current ’Working Folder’ is C:\SATWIN\Test; and
♦
The first command ‘SATNET Epsom98Net’ uses the Epsom98Net.DAT data
file from current Working Folder and the version of SATNET in the current
Program Folder.
The user may change the ’Working Folder’ and ’Program Folder’ at any time via
the Folder Settings menu option.
3.8.5
Running the Test Network
Once the initial installation has been completed, the user may wish to run one of
the SATURN test networks. The Test networks are located in the ‘Support’ tab
(i.e. Support Tab  Installation Checks  Test Networks ) and then either:
3.8.5.1
♦
the Headingley Test will run MXM1 to build trip matrix HAT, followed by
SATNET then SATALL and finally P1X for network HEAD leaving the user in
the P1X interactive mode; whilst
♦
the Epsom Test will repeat the same process for the N10 Network but this
time with a background bitmap of Epsom.
Other Tools
SATWIN11 also allows access to Notepad editor or a command line prompt
through the toolbar as below.
3.8.6
Other SATWIN 11 Features
3.8.6.1
Selective Deletion of Event Log Runs
The user may delete either some or all of the previous runs stored in the Event log
simply highlighting and deleting them.
3.8.6.2
Changing Working Folder
To change the working folder, click the Browse button next to the Working Folder
display bar to Change the Working Folder via a standard Windows folder menu.
Alternatively the user may type or copy/paste a folder in the folder display bar.
Note that the Up and Down arrows will enable the user to move through
previously used paths - this is a good example where it makes sense to have a
separate Model Complex for each working session). If the folder does not exist a
red frame will highlight the folder display bar.
3.8.6.3
Setting the Preferred Text Editor
By default, SATWIN 11 uses Notepad to view SATURN LP files but the user may
specify a different default editor by clicking Set Default Editor from the Settings
menu. The default editor is used automatically when viewing LP files through
SATWIN 11. The default editor may also be accessed through the Tools tab.
5120257 / Mar 14
Section 3.docx
3-30
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.8.6.4
SATURN Manual
The SATURN manual may be accessed at all times from the SATWIN 11 interface
using the icons located in the upper-right corner. Clicking on the icons in this area
will enable the users to view the individual sections and appendices. The latest
documents may also be viewed online via the Support tab too.
3.8.6.5
SATURN Version Information
SATURN version information can be found just under working folder display as
illustrated below.
More detailed information about the SATURN version (as shown in the dialog box
below) is available either through Support tab  Support Info  SATURN
Version Info or by hovering the mouse over the SATURN Version in the settings
panel.
5120257 / Mar 14
Section 3.docx
3-31
SATURN MANUAL (V11.3)
The Basic SATURN Model
If the selection box states Version Unknown’, SATWIN 11 was unable to identify
the specific version (e.g. a version of SATURN previously installed under the
XEXES directory but without the SATURN.VER being created). The reference to
the ‘Version Unknown’ may be removed by the user by:
3.8.6.6
♦
Identifying the SATURN version and Level in use by viewing any of the output
Line Printer file using the executables. The SATURN Version and Level in
use will always be reported at the top of the text file (e.g. Version ‘10.9.24’
and Level ‘N3’); and then
♦
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.9.24 Level N3’
Using Other Programs via the SATURN DOS Command Shell
Access to other non-SATURN (user) programs from the SATURN Command Shell
may be undertaken by specifying the full paths containing the User programs via
SATURN Command Shell Paths from the Tools tab. Once selected, the dialog
box will enable the user to add extra path(s) containing other programs to be
used. They may be added to the Additional User Programmes Paths area by
selecting the path(s) via the ’Browse ...’ button.
3.8.6.7
Saving the Events Log Commands for Re-use
Command(s) in the Events Log area may be saved by selecting the command(s)
then either clicking ‘Save Item(s)’ button on the Toolbar or ’Save EventLog’ from
the File menu. The commands are saved to a user-specified file with the file
extension .CMD. If the user clicks on the ’Save Item(s)’ without selecting a
particular command(s), all the commands in the Events Log are saved.
To re-use previously saved commands, load an Events Log file via the ’File/Open
Eventlog File’ menu option or drag and drop the file onto the Events Log.
5120257 / Mar 14
Section 3.docx
3-32
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.8.6.8
Changing P1X0.Dat preference file
In SATURN default behaviour of certain programs are determined by what is
known as preference files (see SATURN manual 15.2). One such preference file
is the P1X0.DAT file governing the default settings for P1X. This file is editable for
the user and it also may change slightly from version to version.
The file can be replaced as described in 11.2.3 or you can use the VersionsP1X
Preference File Version tool in SATWIN 11.
The tool works on the assumption that the current P1X0.DAT file is located in the
<program folder>\DAT\ folder and that other versions of the P1X0.DAT file is
found in the <program folder>\DAT\P1X0\ with a file naming convention like this:
P1X0_*.DAT where * is the unique title identifying the file to the user.
On selecting a file in the list that file is copied to the DAT folder overwriting any
previously used P1X0.DAT file
In short store your library P1X0.Dat files using the DAT\P1X0\P1X0_*.DAT pattern
and use the SATWIN 11 tool to set the default.
5120257 / Mar 14
Section 3.docx
3-33
SATURN MANUAL (V11.3)
The Basic SATURN Model
3.9
Version Control
JOB NUMBER: 5120257
Revision
5120257 / Mar 14
Section 3.docx
DOCUMENT REF: Section 3.doc
Purpose / Description
Originated
Checked
Reviewed
Authorised
Date
NS
IW
IW
06/05/06
1
Re-formatted (Final to DVV)
TF / BG
3
Upgrade to V2 Templates
IW
22/06/06
3.1
Update Figure 3.1/2
IW
13/07/06
3.2
Web release – Sept 06
DVV
NP
IW
IW
08/09/06
3.3
Web release – Jan 07
DVV
NP
IW
IW
04/01/07
3.4
SATURN v10.7 Release
DVV
NP
IW
IW
12/03/07
3.5
Web release – Jan 07
DVV
NP
IW
IW
04/01/07
3.6
SATURN v10.8 Release
DVV
NP
IW
IW
31/03/08
3.7
Web release – Jul 08
DVV
NP
IW
IW
07/07/08
3.8
Web release – Dec 08
DVV
NP
IW
IW
12/12/08
3.8.21
Web release – Feb 09
DVV
NP
IW
IW
16/02/09
3.8.22
Web release – Jun 09
DVV
NP
IW
IW
16/06/09
10.9.10
SATURN v10.9 Release
DVV
DG
IW
IW
04/09/09
10.9.12
SATURN v10.9 Release (Full)
DVV
DG
IW
IW
27/10/09
10.9.17
Web release – Jun 10
DVV
NP
IW
IW
22/06/10
10.9.22
Web release – Dec 10
DVV
AG
IW
IW
06/12/10
10.9.24
SATURN v10.9 Release (Full)
DVV
AG
IW
IW
06/05/11
11.1.09
SATURN v11,1 Release (Full)
DVV
AG
IW
IW
31/03/12
11.2.01
SATURN v11,2 Beta Release
DVV
JS
IW
IW
07/12/12
11.2.05
SATURN v11,2 Release (Full)
DVV
JS
IW
IW
19/03/13
11.3.03
SATURN v11.3 Release
DVV
EN
IW
IW
28/03/14
3-34