GAMS Python API documentation version 24.1

More documents

Recommendations

Info

30 Class Documentation 4.14.2 Constructor & Destructor Documentation 4.14.2.1 def gams.execution.GamsCheckpoint. init ( self, workspace, checkpoint name = None ) Constructor. Parameters workspace GamsWorkspace containing GamsCheckpoint checkpoint_name Identifier of GamsCheckpoint (determined automatically if omitted) 4.14.3 Member Function Documentation 4.14.3.1 def gams.execution.GamsCheckpoint.add modelinstance ( self, modelinstance name = None ) Create model instance. Parameters modelinstance_name Returns GamsModelInstance instance Identifier of GamsModelInstance (determined automatically if omitted) 4.15 gams.execution.GamsJob Class Reference The GamsJob class manages the execution of a GAMS program given by GAMS model source. Inheritance diagram for gams.execution.GamsJob: Public Member Functions • def __init__ • def run Constructor. Run GamsJob. • def interrupt Properties Send Interrupt to running Job. • name property(get_job_name) Retrieve name of GamsJob. • workspace property(get_workspace) object gams.execution.GamsJob GAMSPythonAPI documentation version 24.1 May 2013
4.15 gams.execution.GamsJob Class Reference 31 Get GamsWorkspace containing GamsJob. • out_db property(get_out_db) Get GamsDatabase created by run method. 4.15.1 Detailed Description The GamsJob class manages the execution of a GAMS program given by GAMS model source. The GAMS source (or more precisely the root of a model source tree) of the job can be provided as a string or by a filename (relative to the working directory of the GamsWorkspace) of a text file containing the GAMS model source. The run method organizes the export of the input GamsDatabases, calls the GAMS compiler and execution system with the supplied options and on successful completion provides through the property out_db (of type Gams- Database) the results of the model run. While the result data is captured in a GamsDatabase, the run method can also create a GamsCheckpoint that not only captures data but represents the state of the entire GamsJob and allows some other GamsJob to continue from this state. In case of a compilation or execution error, the run method will throw an exception. If the log output of GAMS is of interest, this can be captured by providing the output parameter of the run method (e.g. sys.stdout). 4.15.2 Constructor & Destructor Documentation 4.15.2.1 def gams.execution.GamsJob. init ( self, ws, file name = None, source = None, checkpoint = None, job name = None ) Constructor. Note It is not allowed to specify both file_name and source at the same time. Parameters ws GamsWorkspace containing GamsJob file_name GAMS source file name source GAMS model as string checkpoint GamsCheckpoint to initialize GamsJob from job_name Job name (determined automatically if omitted) 4.15.3 Member Function Documentation 4.15.3.1 def gams.execution.GamsJob.interrupt ( self ) Send Interrupt to running Job. Returns False if no process available, True otherwise 4.15.3.2 def gams.execution.GamsJob.run ( self, gams options = None, checkpoint = None, output = None, create out db = True, databases = None ) Run GamsJob. GAMSPythonAPI documentation version 24.1 May 2013
Page 1: GAMS Python API documentation versi
Page 4 and 5: ii CONTENTS 4.3.1 Detailed Descript
Page 6 and 7: iv CONTENTS 4.22.1 Detailed Descrip
Page 8 and 9: vi CONTENTS 4.51.1 Detailed Descrip
Page 10 and 11: 2 GAMS Python API export PYTHONPATH
Page 12 and 13: 4 GAMS Python API GAMSPythonAPI doc
Page 14 and 15: 6 Hierarchical Index gams.options.S
Page 16 and 17: 8 Class Index gams.execution.Symbol
Page 18 and 19: 10 Class Index GAMSPythonAPI docume
Page 20 and 21: 12 Class Documentation Properties
Page 22 and 23: 14 Class Documentation 4.1.2.8 def
Page 24 and 25: 16 Class Documentation Get GamsEqua
Page 26 and 27: 18 Class Documentation In the GAMS
Page 28 and 29: 20 Class Documentation See Also add
Page 30 and 31: 22 Class Documentation Parameters R
Page 34 and 35: 26 Class Documentation 4.8 gams.dat
Page 36 and 37: 28 Class Documentation 4.12 gams.da
Page 40 and 41: 32 Class Documentation Parameters g
Page 42 and 43: 34 Class Documentation 17 for rec i
Page 44 and 45: 36 Class Documentation 4.18 gams.ex
Page 46 and 47: 38 Class Documentation 4.20.1 Detai
Page 48 and 49: 40 Class Documentation • int Dot
Page 52 and 53: 44 Class Documentation • bratio p
Page 54 and 55: 46 Class Documentation 4.29 gams.op
Page 56 and 57: 48 Class Documentation Inheritance
Page 58 and 59: 50 Class Documentation 4.37 gams.op
Page 60 and 61: 52 Class Documentation 4.40.1 Detai
Page 62 and 63: 54 Class Documentation 4.45 gams.wo
Page 64 and 65: 56 Class Documentation There was a
Page 66 and 67: 58 Class Documentation • major_re
Page 68 and 69: 60 Class Documentation Returns Gams
Page 70 and 71: 62 Class Documentation Parameters m
Page 72 and 73: 64 Class Documentation • int Capa
Page 74 and 75: Index __init__ gams::execution::Gam
Page 76: 68 INDEX gams::database::GamsDataba

GAMS Python API documentation version 24.1

Create successful ePaper yourself

Delete template?

Save as template?