5.2. Running E-Cell Session Script

There are three ways to execute ESS;

5.2.1. Running ESS in command line mode

An ESS can be run by using ecell3-session command either in batch mode or in interactive mode.

5.2.1.1. Batch mode

To execute an ESS file without user interaction, type the following command at the shell prompt:


          $ ecell3-session [-f model.eml] [-e] ess.py
          
        
ecell3-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.

5.2.1.2. Interactive mode

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 
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.

5.2.1.3. Giving parameters to the script

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-session -DNAME1=VALUE1 -DNAME2=VALUE2...
          $ ecell3-session --parameters="{'NAME1':VALUE1,'NAME2':VALUE2,...}"
        
Both ways, -D and --parameters, can be mixed.

5.2.2. Loading ESS from Osogo Session Monitor

To manually load an ESS file from the GUI, use File->loadScript menu button.

gecell command accepts -e and -f options in the same way as the ecell3-session command.

5.2.3. Using SessionManager

(a separate chapter?)