E-Cell Simulation Environment Version 3.1.100 User's Manual (Draft: Dec. 18, 2003) | ||
---|---|---|
Prev | Chapter 5. Scripting A Simulation Session | Next |
There are three ways to execute ESS;
Execute the script from the operating system's command line (the shell prompt).
Load the script from frontend software such as Osogo Session Monitor.
Use SessionManager to automate the invokation of the simulation sessions itself. This is usually used to write mathematical analysis scripts, such as parameter tuning, which involves multiple runs of the simulator.
An ESS can be run by using ecell3-session command either in batch mode or in interactive mode.
To execute an ESS file without user interaction, type the following command at the shell prompt:
$ ecell3-session [-f model.eml] [-e] ess.pyecell3-session command creates a simulation Session object and executes the ESS file ess.py on it. The option [-e] can be omitted. Optionally, if [-f model.eml] is given, the EML file model.eml is loaded immediately before executing the ESS.
To run the ecell3-session in interactive mode, invoke the command without an ESS file.
$ ecell3-session [-f model.eml]
ecell3-session [ for E-Cell SE Version 3, on Python Version 2.2.1 ]
Copyright (C) 1996-2002 Keio University.
Send feedback to Koichi Takahashi <shafi@e-cell.org>
ecell3-session>>>
The banner and the prompt shown here may vary according to the
version you are using. If the option [-f model.eml]
is given, the EML file model.eml is loaded immediately before prompting.
Optionally session parameters can be given to the script. Given session parameters can be accessible from the ESS script as global variables (see the following section).
To give the ESS parameters from the
ecell3-session command, use either
-D
or --parameters=
option.
$ ecell3-sessionBoth ways,-D
NAME1=VALUE1-D
NAME2=VALUE2... $ ecell3-session--parameters="
{'NAME1':VALUE1,'NAME2':VALUE2,...}"
-D
and --parameters
, can be mixed.
To manually load an ESS file from the GUI, use
-> menu button.gecell command accepts
-e
and -f
options in the same way as the
ecell3-session command.
(a separate chapter?)