Follow these steps to submit a job to NEOS via XML-RPC clients:
Save the following template using your browser's copy and paste tools
Using your favorite editor, plug your data files and parameters into
the message in the indicated spots
Descriptions of the input are written with the web interface in
mind. If the description asks for the name of a file, then you will
instead need to insert the contents of the file itself.
The <![CDATA[ ... ]]> tag is an escape
indicator. This will ensure that any special characters in your inputs
(such as <, >, &, etc.) will be interpreted correctly.
For XML-RPC, you need to submit the contents of this file to NEOS with
the
submitJob() method, and retrieve the results with
the getResults() method.
Go here for more
information on using the XML-RPC interface to NEOS.
Note: keep in mind that the Gurobi solvers are not available via the
XML-RPC interface. Please use the web submission form.
<document>
<category>milp</category>
<solver>Gurobi</solver>
<inputMethod>GAMS</inputMethod>
<email> insert valid email address </email>
<model><![CDATA[...Insert Value Here...]]></model>
<options><![CDATA[...Insert Value Here...]]></options>
<parameters><![CDATA[...Insert Value Here...]]></parameters>
<gdx>...Insert Value Here...</gdx>
<restart>...Insert Value Here...</restart>
<wantgdx><![CDATA[...Insert Value Here...]]></wantgdx>
<wantlst><![CDATA[...Insert Value Here...]]></wantlst>
<wantlog><![CDATA[...Insert Value Here...]]></wantlog>
<comments><![CDATA[...Insert Value Here...]]></comments>
</document>
Description of input values
model
Upload the GAMS model file.
options
The solver options file is optional. If provided, the statement
<modelname>.optfile = 1 ; is required
before the solve statement in your model file. Only
optfile = 1 is supported, however, options
also may be specified within the model input file (see the GAMS
documentation).
parameters
A secondary parameters file may be uploaded to NEOS. This file is
optional. Note that some settings are overwritten by NEOS default settings.
(See GAMS Call and CL Parameters
for more details.)
gdx
Optional GDX file for inputs. This file will be renamed to
"in.gdx". The model must include "$GDXIN in.gdx" to load this
file.
restart
A GAMS restart file can be submitted to NEOS.
(See GAMS Save and Restart
for more details.)
wantgdx
Check the box to have the solver return a compressed GDX file that
contains all of the symbols in the model.
wantlst
Check the box to include the GAMS listing file in returned output.
wantlog
If the box is checked, the log file containing information generated
by the solver will be returned with the output.
comments
You may enter any additional comments here, for example,
to identify the data for your own information. These comments will be
returned with your results.