A complete XML-RPC client for the Neos Numerical Optimisation Server. Works in the browser and Node.js
To install via npm:
npm install neos-js
Or grab a release archive file from the dist folder.
Browser: In the header include
<script src="assets/neos.min.js"></script>then
<script type="text/javascript">
NEOS.getSolverTemplate('MILP', 'CPLEX', 'GAMS')
.then(template => {
return NEOS.prepareJob(template, model, 'emailMandatoryForCPLEX@test.com')
})
.then(NEOS.submitJob)
.then(NEOS.getFinalResults)
.then(res => {
// work with the resulting listing file
})
.catch(err => {
// catch errors
})
</script>Check out the NEOS online editor example
Node.js
const NEOS = require('neos-js')
const fs = require('fs')
// load a simulation model, in this case a GAMS file
const model = fs.readFileSync('transport_model.gms', 'utf-8')
// convert the simulation into a NEOS XML string,
// solve and await the results
NEOS.getSolverTemplate('MILP', 'CPLEX', 'GAMS')
.then(template => {
return NEOS.prepareJob(template, model, 'emailMandatoryForCPLEX@test.com')
})
.then(NEOS.submitJob)
.then(NEOS.getFinalResults)
.then(res => {
// work with the resulting listing file
})
.catch(err => {
// catch errors
})For a complete list of the available methods, visit the Neos Server XML-RPC API documentation.
Additional methods:
prepareJob(template, model, email)
Convenience method. Converts your simulation model (string) into the required NEOS XML format that you get from the getSolverTemplate method. An email is required for some solvers (e.g. CPLEX), so make sure to pass one.
Contribution is highly appreciated! Make sure to npm test before submitting a PR
MIT