@frontlinesystems/rason-mcp-server 2026.5.1 → 2026.5.3

package/examples/rason-features/ReferenceGuide/RGFirehouseLocationConic.json

@@ -1,114 +1,114 @@
-{
-  "modelName": "RGFirehouseLocationConic",
-  "modelDescription": "RASON Conic Optimization Example: Example of solving a Conic Optimization Model. The goal of this example is the same for the RGFirehouseLocation example, to find a location, given by x and y coordinates, of a proposed firehouse that minimizes the maximum distance between the firehouse and six cities in the region. The difference between this example and the RGFirehouseLocation example is that this example replaces the 6 nonlinear constraints (calculating the distances betwen the proposed firehouse location and each city) with a 6 conic constraints. Since the model is now a conic optimization model, the SOCP Barrier engine can be used. ",
-  "modelType": "optimization",
-  "engineSettings": {
-    "comment": "Since the model is now a conic optimization model, the SOCP Barrier engine can be used to solve the model. Note:  In RASON, you can solve any type of model containing conic constraints. There is no need to select a specific engine within engineSettings. If the model is diagnosed as 'SOCP', then the model will be solved using an engine that supports conic constraints. Currently, the three engines that support conic constraints are: 'SOCP Barrier', 'Gurobi Solver' and 'Mosek Solver'.",
-    "engine": "SOCP Barrier"
-  },
-  "variables": {
-    "comment": "The variables for this conic formulation contains the three original variables: x and y, which will hold the final x,y coordinate values for the proposed firehouse and z, the variale to be minimized in the objective function. 18 new variables in the f, g and h arrays, are required for the 6 conic constraints. Each member of the f, g, and h variable blocks must (for example f[1], g[1], and h[1]) belong to a second order cone constraint  which can be rewritten as f[1] > = SQRT (SUMSQ(g[1]; h[1])).  ",
-    "x": {
-      "comment": "The x variable will hold the final x coordinate of the proposed firehouse.",
-      "value": 1.0,
-      "finalValue": []
-    },
-    "y": {
-      "comment": "The y variable will hold the final y coordinate of the proposed firehouse.",
-      "value": 1.0,
-      "finalValue": []
-    },
-    "z": {
-      "comment": "The z variable will be minimized in the objective.",
-      "value": 1.0,
-      "finalValue": []
-    },
-    "f": {
-      "comment": "The f block of variables will be forced by the dx block of constraints to equal the distance between the x coordinate of the proposed firehouse and the x coordinate of each city.",
-      "dimensions": [ 6 ],
-      "value": 1.0,
-      "finalValue": []
-    },
-    "g": {
-      "comment": "The g block of variables will be forced by the dy block of constraints to equal the distance between the y coordinate of the proposed firehouse and the y coordinate of each city.",
-      "dimensions": [ 6 ],
-      "value": 1.0
-    },
-    "h": {
-      "comment": "The h block of variables will be driven by the dz block of constraints to be less than or equal to z, the variable to be minimized in the objective function.",
-      "dimensions": [ 6 ],
-      "value": 1.0
-    }
-  },
-  "data": {
-    "comment": "The x and y coordinates of each of the 6 cities to be served by the firehouse are given in the corx and cory arrays, respectively. In the RGFirehouseLocation example, these coordinates were supplied in the constraint formulas.",
-    "corx": {
-      "comment": "x coordinates of the each of the 6 cities.",
-      "dimensions": [ 6 ],
-      "value": [ 1, 0.5, 2, 2, 2, 0.5 ]
-    },
-    "cory": {
-      "comment": "y coordinates of the each of the 6 cities.",
-      "dimensions": [ 6 ],
-      "value": [ 4, 3, 4, 2, 5, 6 ]
-    }
-  },
-  "constraints": {
-    "dx": {
-      "comment": "This constraint calculates the differences between the X coordinates of the hub and each city set equal to the new variables in the g block.",
-      "dimensions": [ 6 ],
-      "formula": "corx - x - g",
-      "equal": 0
-    },
-    "dy": {
-      "comment": "This constraint calculates the differences between the Y coordinates of the hub and each city set equal to the new variables in the h block.",
-      "dimensions": [ 6 ],
-      "formula": "cory - y - h",
-      "equal": 0
-    },
-    "dz": {
-      "comment": "The effect of this constraint, coupled with the minimization of the Z variable, results in the Z variable being set equal to the maximum value in the F variable block, in the final solution.",
-      "dimensions": [ 6 ],
-      "formula": "f - z",
-      "upper": 0
-    },
-    "cone1": {
-      "comment": "Each set of the f, g, and h variables must belong to a second order cone constraint which can be rewritten as F >= SQRT(SUMSQ(G,H)), in this constraint specifically: F[1] >= SQRT(SUMSQ(G[1],H[1])). These 6 conic constraints replace the nonlinear distance calculation in the previous RGFirehouseLocation example.",
-      "value": "f[1], g[1], h[1]",
-      "type": "cone"
-    },
-    "cone2": {
-      "comment": "F[2] >= SQRT(SUMSQ(G[2],H[2]))",
-      "value": "f[2], g[2], h[2]",
-      "type": "cone"
-    },
-    "cone3": {
-      "comment": "F[3] >= SQRT(SUMSQ(G[3],H[3]))",
-      "value": "f[3], g[3], h[3]",
-      "type": "cone"
-    },
-    "cone4": {
-      "comment": "F[4] >= SQRT(SUMSQ(G[4],H[4]))",
-      "value": "f[4], g[4], h[4]",
-      "type": "cone"
-    },
-    "cone5": {
-      "comment": "F[5] >= SQRT(SUMSQ(G[5],H[5]))",
-      "value": "f[5], g[5], h[5]",
-      "type": "cone"
-    },
-    "cone6": {
-      "comment": "F[6] >= SQRT(SUMSQ(G[6],H[6]))",
-      "value": "f[6], g[6], h[6]",
-      "type": "cone"
-    }
-  },
-  "objective": {
-    "obj": {
-      "comment": "Minimizing the z variable in the objective function will push the maximum distance between the proposed firehouse location and each city to the lowest possible value guaranteeing that the firehouse is as close as possible to each of the six cities. ",
-      "formula": "z",
-      "type": "minimize",
-      "finalValue": []
-    }
-  }
+{
+  "modelName": "RGFirehouseLocationConic",
+  "modelDescription": "RASON Conic Optimization Example: Example of solving a Conic Optimization Model. The goal of this example is the same for the RGFirehouseLocation example, to find a location, given by x and y coordinates, of a proposed firehouse that minimizes the maximum distance between the firehouse and six cities in the region. The difference between this example and the RGFirehouseLocation example is that this example replaces the 6 nonlinear constraints (calculating the distances betwen the proposed firehouse location and each city) with a 6 conic constraints. Since the model is now a conic optimization model, the SOCP Barrier engine can be used. ",
+  "modelType": "optimization",
+  "engineSettings": {
+    "comment": "Since the model is now a conic optimization model, the SOCP Barrier engine can be used to solve the model. Note:  In RASON, you can solve any type of model containing conic constraints. There is no need to select a specific engine within engineSettings. If the model is diagnosed as 'SOCP', then the model will be solved using an engine that supports conic constraints. Currently, the three engines that support conic constraints are: 'SOCP Barrier', 'Gurobi Solver' and 'Mosek Solver'.",
+    "engine": "SOCP Barrier"
+  },
+  "variables": {
+    "comment": "The variables for this conic formulation contains the three original variables: x and y, which will hold the final x,y coordinate values for the proposed firehouse and z, the variale to be minimized in the objective function. 18 new variables in the f, g and h arrays, are required for the 6 conic constraints. Each member of the f, g, and h variable blocks must (for example f[1], g[1], and h[1]) belong to a second order cone constraint  which can be rewritten as f[1] > = SQRT (SUMSQ(g[1]; h[1])).  ",
+    "x": {
+      "comment": "The x variable will hold the final x coordinate of the proposed firehouse.",
+      "value": 1.0,
+      "finalValue": []
+    },
+    "y": {
+      "comment": "The y variable will hold the final y coordinate of the proposed firehouse.",
+      "value": 1.0,
+      "finalValue": []
+    },
+    "z": {
+      "comment": "The z variable will be minimized in the objective.",
+      "value": 1.0,
+      "finalValue": []
+    },
+    "f": {
+      "comment": "The f block of variables will be forced by the dx block of constraints to equal the distance between the x coordinate of the proposed firehouse and the x coordinate of each city.",
+      "dimensions": [ 6 ],
+      "value": 1.0,
+      "finalValue": []
+    },
+    "g": {
+      "comment": "The g block of variables will be forced by the dy block of constraints to equal the distance between the y coordinate of the proposed firehouse and the y coordinate of each city.",
+      "dimensions": [ 6 ],
+      "value": 1.0
+    },
+    "h": {
+      "comment": "The h block of variables will be driven by the dz block of constraints to be less than or equal to z, the variable to be minimized in the objective function.",
+      "dimensions": [ 6 ],
+      "value": 1.0
+    }
+  },
+  "data": {
+    "comment": "The x and y coordinates of each of the 6 cities to be served by the firehouse are given in the corx and cory arrays, respectively. In the RGFirehouseLocation example, these coordinates were supplied in the constraint formulas.",
+    "corx": {
+      "comment": "x coordinates of the each of the 6 cities.",
+      "dimensions": [ 6 ],
+      "value": [ 1, 0.5, 2, 2, 2, 0.5 ]
+    },
+    "cory": {
+      "comment": "y coordinates of the each of the 6 cities.",
+      "dimensions": [ 6 ],
+      "value": [ 4, 3, 4, 2, 5, 6 ]
+    }
+  },
+  "constraints": {
+    "dx": {
+      "comment": "This constraint calculates the differences between the X coordinates of the hub and each city set equal to the new variables in the g block.",
+      "dimensions": [ 6 ],
+      "formula": "corx - x - g",
+      "equal": 0
+    },
+    "dy": {
+      "comment": "This constraint calculates the differences between the Y coordinates of the hub and each city set equal to the new variables in the h block.",
+      "dimensions": [ 6 ],
+      "formula": "cory - y - h",
+      "equal": 0
+    },
+    "dz": {
+      "comment": "The effect of this constraint, coupled with the minimization of the Z variable, results in the Z variable being set equal to the maximum value in the F variable block, in the final solution.",
+      "dimensions": [ 6 ],
+      "formula": "f - z",
+      "upper": 0
+    },
+    "cone1": {
+      "comment": "Each set of the f, g, and h variables must belong to a second order cone constraint which can be rewritten as F >= SQRT(SUMSQ(G,H)), in this constraint specifically: F[1] >= SQRT(SUMSQ(G[1],H[1])). These 6 conic constraints replace the nonlinear distance calculation in the previous RGFirehouseLocation example.",
+      "value": "f[1], g[1], h[1]",
+      "type": "cone"
+    },
+    "cone2": {
+      "comment": "F[2] >= SQRT(SUMSQ(G[2],H[2]))",
+      "value": "f[2], g[2], h[2]",
+      "type": "cone"
+    },
+    "cone3": {
+      "comment": "F[3] >= SQRT(SUMSQ(G[3],H[3]))",
+      "value": "f[3], g[3], h[3]",
+      "type": "cone"
+    },
+    "cone4": {
+      "comment": "F[4] >= SQRT(SUMSQ(G[4],H[4]))",
+      "value": "f[4], g[4], h[4]",
+      "type": "cone"
+    },
+    "cone5": {
+      "comment": "F[5] >= SQRT(SUMSQ(G[5],H[5]))",
+      "value": "f[5], g[5], h[5]",
+      "type": "cone"
+    },
+    "cone6": {
+      "comment": "F[6] >= SQRT(SUMSQ(G[6],H[6]))",
+      "value": "f[6], g[6], h[6]",
+      "type": "cone"
+    }
+  },
+  "objective": {
+    "obj": {
+      "comment": "Minimizing the z variable in the objective function will push the maximum distance between the proposed firehouse location and each city to the lowest possible value guaranteeing that the firehouse is as close as possible to each of the six cities. ",
+      "formula": "z",
+      "type": "minimize",
+      "finalValue": []
+    }
+  }
 }

package/examples/rason-features/ReferenceGuide/RGProductMixCsv1.json

@@ -1,108 +1,108 @@
-{
-  "modelName": "RGProductMixCsv1",
-  "modelDescription": "RASON Conic Optimization Example: Illustrates binding to a CSV File. In this example, initial variable values are first imported from the CSV file ResultVarsInit.txt and, after the model is solved, the final variable values are saved back to that same CSV file. The final constraint values are saved to ResultFcns.txt and the final objective value is saved to ResultObj.txt. Both ResultFcns.txt and ResultObj.txt will be created once the model is solved. (Click Download RASON Examples icon to download all source files. To attach the files to the example, click Choose Files, navigate to the location of the saved files, select ProductMixParts.txt, ProductMixInventory.txt, ProductMixProfits.txt and ResultVarsInit.txt and click Open. Then POST the model by clicking the POST icon, then solve the model by clicking the down arrow next to the Play icon and selecting Solve.",
-  "modelType": "optimization",
-  "datasources": {
-    "comment": "Imports data from outside datasources.",
-    "parts_data": {
-      "comment": "Imports the parts data.",
-      "type": "csv",
-      "connection": "ProductMixParts.txt",
-      "indexCols": [ "parts", "prods" ],
-      "valueCols": [ "qty" ],
-      "direction": "import"
-    },
-    "invent_data": {
-      "comment": "Imports the inventory data.",
-      "type": "csv",
-      "connection": "ProductMixInventory.txt",
-      "indexCols": [ "parts" ],
-      "valueCols": [ "inventory" ],
-      "direction": "import"
-    },
-    "profit_data": {
-      "comment": "Imports the profit per unit data.",
-      "type": "csv",
-      "connection": "ProductMixProfits.txt",
-      "indexCols": [ "prods" ],
-      "valueCols": [ "profits" ],
-      "direction": "import"
-    },
-    "vars_data": {
-      "comment": "The vars_data data source performs a dual function by first importing the decision variable initial values from the CSV file ResultVarsInit.txt and then saving the final variable values back to that same file. The first property, type, specifies the type of file where the data is being imported/exported ('csv') while the second property, connection, specifies the file name within quotes ('ResultVarsInit.txt'). The third and fourth properties (indexCols and valueCols) are required for importing the initial variable values. The third property, indexCols specifies the dimension(s) (or column(s)) to be imported and the fourth property, valueCols, specifies the values to be imported.  Within variables, a block of decision variables x is bound to the vars_data data source using the binding property.  Since  only one output property is passed within the x definition, finalValue:[], a single column containing the final values of the decision variables will be appended to ResultVarsInit.txt. The last property, direction: 'import/export', stipulates that the contents of the file will be 'imported' (for initial variable values) and then the final variable values will be 'exported', hence the setting 'import/export'.",
-      "type": "csv",
-      "connection": "ResultVarsInit.txt",
-      "indexCols": [ "prods" ],
-      "valueCols": [ "initials" ],
-      "direction": "import/export"
-    },
-    "fcns_data": {
-      "comment": "The fcns_data datasource exports the final constraint values to the TXT file, ResultFcns.txt. The first property, type, specifies the type of file where the data is being imported/exported. In this example, the file is a CSV file.   The second property, connection, specifies the file name within quotes ('ResultFcns.txt') while the third property assigns the direction of the file as 'export'. The binding property within the c constraint definition binds the constraint block to the fcns_data data source. The user must specify which results he/she would like exported. In this example, only one output property is passed, finalValue:[].  For a complete list of results that may be written to a writeable data source, see the constraints section discussion within the RASON Reference Guide on the Help tab.",
-      "type": "csv",
-      "connection": "ResultFcns.txt",
-      "direction": "export"
-    },
-    "obj_data": {
-      "comment": "The obj_data datasource exports the final objective value to the TXT file, ResultObj.txt. The first property, type, specifies the file type ('CSV') while the second property, connection, specifies the file name ('ResultObj.txt')and the third, direction, specifies that the file will be exported. Within objective, the total objective function is bound to the obj_data data source.  The only output property passed within the objective definition is finalValue:[].  As a result, only the final objective function value will be exported to ResultObj.txt.   For a complete list of results that may be written to a writeable data source, see the objective section discussion in the RASON Reference Guide.",
-      "type": "csv",
-      "connection": "ResultObj.txt",
-      "direction": "export"
-    }
-  },
-  "data": {
-    "comment": "Binds the datasources to data component.",
-    "parts2": {
-      "comment": "Binds the values in the qty column in the parts_data datasource to parts2 data component.",
-      "binding": "parts_data",
-      "valueCol": "qty"
-    },
-    "invent": {
-      "comment": "Binds the values in the inventory column in the invent_data datasource to invent data component.",
-      "binding": "invent_data",
-      "valueCol": "inventory"
-    },
-    "profit": {
-      "comment": "Binds the values in the profits column in the profit_data datasource to profit data component.",
-      "binding": "profit_data",
-      "valueCol": "profits"
-    }
-  },
-  "formulas": {
-    "comment": "Use this section to calculate intermediate formulas to be used within the constraints and objective sections.",
-    "piv_parts": {
-      "comment": "Calculates the amount of parts used to produce all three products.",
-      "formula": "PIVOT(parts2, { 'prods' }, { 'parts' })"
-    }
-  },
-  "variables": {
-    "comment": "Decision Variables",
-    "x": {
-      "comment": "The amount of products to produce, x[1] = TVs, x[2] = Stereos, x[3] = Speakers",
-      "binding": "vars_data",
-      "valueCol": "initials",
-      "lower": 0,
-      "finalValue": []
-    }
-  },
-  "constraints": {
-    "comment": "Constraints",
-    "c": {
-      "comment": "Generates 5 constraints that calculate the number of parts used in creating the three products, then sets each constraint equal to the amount of each part in inventory.",
-      "dimensions": [ "parts" ],
-      "binding": "fcns_data",
-      "formula": "MMULT(piv_parts, x)",
-      "upper": "invent",
-      "finalValue": []
-    }
-  },
-  "objective": {
-    "comment": "objective function",
-    "total": {
-      "comment": "Calculates the profit by multiplying the profit per unit of each product by the final variable values.",
-      "binding": "obj_data",
-      "formula": "sumproduct(x, profit)",
-      "type": "maximize",
-      "finalValue": []
-    }
-  }
+{
+  "modelName": "RGProductMixCsv1",
+  "modelDescription": "RASON Conic Optimization Example: Illustrates binding to a CSV File. In this example, initial variable values are first imported from the CSV file ResultVarsInit.txt and, after the model is solved, the final variable values are saved back to that same CSV file. The final constraint values are saved to ResultFcns.txt and the final objective value is saved to ResultObj.txt. Both ResultFcns.txt and ResultObj.txt will be created once the model is solved. (Click Download RASON Examples icon to download all source files. To attach the files to the example, click Choose Files, navigate to the location of the saved files, select ProductMixParts.txt, ProductMixInventory.txt, ProductMixProfits.txt and ResultVarsInit.txt and click Open. Then POST the model by clicking the POST icon, then solve the model by clicking the down arrow next to the Play icon and selecting Solve.",
+  "modelType": "optimization",
+  "datasources": {
+    "comment": "Imports data from outside datasources.",
+    "parts_data": {
+      "comment": "Imports the parts data.",
+      "type": "csv",
+      "connection": "ProductMixParts.txt",
+      "indexCols": [ "parts", "prods" ],
+      "valueCols": [ "qty" ],
+      "direction": "import"
+    },
+    "invent_data": {
+      "comment": "Imports the inventory data.",
+      "type": "csv",
+      "connection": "ProductMixInventory.txt",
+      "indexCols": [ "parts" ],
+      "valueCols": [ "inventory" ],
+      "direction": "import"
+    },
+    "profit_data": {
+      "comment": "Imports the profit per unit data.",
+      "type": "csv",
+      "connection": "ProductMixProfits.txt",
+      "indexCols": [ "prods" ],
+      "valueCols": [ "profits" ],
+      "direction": "import"
+    },
+    "vars_data": {
+      "comment": "The vars_data data source performs a dual function by first importing the decision variable initial values from the CSV file ResultVarsInit.txt and then saving the final variable values back to that same file. The first property, type, specifies the type of file where the data is being imported/exported ('csv') while the second property, connection, specifies the file name within quotes ('ResultVarsInit.txt'). The third and fourth properties (indexCols and valueCols) are required for importing the initial variable values. The third property, indexCols specifies the dimension(s) (or column(s)) to be imported and the fourth property, valueCols, specifies the values to be imported.  Within variables, a block of decision variables x is bound to the vars_data data source using the binding property.  Since  only one output property is passed within the x definition, finalValue:[], a single column containing the final values of the decision variables will be appended to ResultVarsInit.txt. The last property, direction: 'import/export', stipulates that the contents of the file will be 'imported' (for initial variable values) and then the final variable values will be 'exported', hence the setting 'import/export'.",
+      "type": "csv",
+      "connection": "ResultVarsInit.txt",
+      "indexCols": [ "prods" ],
+      "valueCols": [ "initials" ],
+      "direction": "import/export"
+    },
+    "fcns_data": {
+      "comment": "The fcns_data datasource exports the final constraint values to the TXT file, ResultFcns.txt. The first property, type, specifies the type of file where the data is being imported/exported. In this example, the file is a CSV file.   The second property, connection, specifies the file name within quotes ('ResultFcns.txt') while the third property assigns the direction of the file as 'export'. The binding property within the c constraint definition binds the constraint block to the fcns_data data source. The user must specify which results he/she would like exported. In this example, only one output property is passed, finalValue:[].  For a complete list of results that may be written to a writeable data source, see the constraints section discussion within the RASON Reference Guide on the Help tab.",
+      "type": "csv",
+      "connection": "ResultFcns.txt",
+      "direction": "export"
+    },
+    "obj_data": {
+      "comment": "The obj_data datasource exports the final objective value to the TXT file, ResultObj.txt. The first property, type, specifies the file type ('CSV') while the second property, connection, specifies the file name ('ResultObj.txt')and the third, direction, specifies that the file will be exported. Within objective, the total objective function is bound to the obj_data data source.  The only output property passed within the objective definition is finalValue:[].  As a result, only the final objective function value will be exported to ResultObj.txt.   For a complete list of results that may be written to a writeable data source, see the objective section discussion in the RASON Reference Guide.",
+      "type": "csv",
+      "connection": "ResultObj.txt",
+      "direction": "export"
+    }
+  },
+  "data": {
+    "comment": "Binds the datasources to data component.",
+    "parts2": {
+      "comment": "Binds the values in the qty column in the parts_data datasource to parts2 data component.",
+      "binding": "parts_data",
+      "valueCol": "qty"
+    },
+    "invent": {
+      "comment": "Binds the values in the inventory column in the invent_data datasource to invent data component.",
+      "binding": "invent_data",
+      "valueCol": "inventory"
+    },
+    "profit": {
+      "comment": "Binds the values in the profits column in the profit_data datasource to profit data component.",
+      "binding": "profit_data",
+      "valueCol": "profits"
+    }
+  },
+  "formulas": {
+    "comment": "Use this section to calculate intermediate formulas to be used within the constraints and objective sections.",
+    "piv_parts": {
+      "comment": "Calculates the amount of parts used to produce all three products.",
+      "formula": "PIVOT(parts2, { 'prods' }, { 'parts' })"
+    }
+  },
+  "variables": {
+    "comment": "Decision Variables",
+    "x": {
+      "comment": "The amount of products to produce, x[1] = TVs, x[2] = Stereos, x[3] = Speakers",
+      "binding": "vars_data",
+      "valueCol": "initials",
+      "lower": 0,
+      "finalValue": []
+    }
+  },
+  "constraints": {
+    "comment": "Constraints",
+    "c": {
+      "comment": "Generates 5 constraints that calculate the number of parts used in creating the three products, then sets each constraint equal to the amount of each part in inventory.",
+      "dimensions": [ "parts" ],
+      "binding": "fcns_data",
+      "formula": "MMULT(piv_parts, x)",
+      "upper": "invent",
+      "finalValue": []
+    }
+  },
+  "objective": {
+    "comment": "objective function",
+    "total": {
+      "comment": "Calculates the profit by multiplying the profit per unit of each product by the final variable values.",
+      "binding": "obj_data",
+      "formula": "sumproduct(x, profit)",
+      "type": "maximize",
+      "finalValue": []
+    }
+  }
 }