Main

APM Python Interface Documentation

Main.PythonFunctions History

Hide minor edits - Show changes to output

Added line 17:
** [[Main/INFO|More information about FV, MV, SV, and CV types]]
Added lines 10-14:
** Typical commands are 'clear all', 'clear csv', 'clear apm', 'solve'.
** 'clear all': Clear the prior application
** 'clear csv': Clear just the data file (CSV)
** 'clear apm': Clear just the model file (APM)
** 'solve': Solve the problem
Added lines 17-20:
** Type FV: Fixed value, one decision or fixed value over the time horizon
** Type MV: Manipulated variable, multiple decision values over the horizon
** Type SV: State variable, view in web-viewer but don't control
** Type CV: Controlled variable with target variable
Added line 22:
** Example: ip = apm_ip('http://apmonitor.com')
May 17, 2014, at 08:13 PM by 107.188.175.164 -
Changed lines 9-25 from:
* [[http://apmonitor.com/apm_html/apm.py.html|apm(server,app,aline) - Send commands to the server]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_get(server,app,filename) - Retrieve a file from the server]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_info(server,app,type,aline) - Classify a parameter or variable]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_ip(server) - Retrieve the client IP address]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_load(server,app,filename) - Load model file]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_meas(server,app,name,value) - Specify a measurement]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_option(server,app,name,value) - Set an option]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_sol(server,app) - Retrieve the solution]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_tag(server,app,name) - Retrieve an option]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_t0(server,app,mode) - Retrieve an restart file]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_web(server,app) - Open a web interface to the dashboard]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_web_root(server,app) - Open a web interface to the root directory]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_web_var(server,app) - Open a web interface to the variable values]]
* [[http://apmonitor.com/apm_html/apm.py.html|csv_data(server,app,filename) - Load data file locally]]
* [[http://apmonitor.com/apm_html/apm.py.html|csv_element(name,row,replay) - Retrieve an element from loaded csv data]]
* [[http://apmonitor.com/apm_html/apm.py.html|csv_load(server,app,filename) - Load data file]]
* [[http://apmonitor.com/apm_html/apm.py.html|csv_lookup(name,replay) - Retrieve the column number for a variable]]
to:
* [[http://apmonitor.com/apm_html/apm_py.html|apm(server,app,aline) - Send commands to the server]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_get(server,app,filename) - Retrieve a file from the server]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_info(server,app,type,aline) - Classify a parameter or variable]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_ip(server) - Retrieve the client IP address]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_load(server,app,filename) - Load model file]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_meas(server,app,name,value) - Specify a measurement]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_option(server,app,name,value) - Set an option]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_sol(server,app) - Retrieve the solution]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_tag(server,app,name) - Retrieve an option]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_t0(server,app,mode) - Retrieve an restart file]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_web(server,app) - Open a web interface to the dashboard]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_web_root(server,app) - Open a web interface to the root directory]]
* [[http://apmonitor.com/apm_html/apm_py.html|apm_web_var(server,app) - Open a web interface to the variable values]]
* [[http://apmonitor.com/apm_html/apm_py.html|csv_data(server,app,filename) - Load data file locally]]
* [[http://apmonitor.com/apm_html/apm_py.html|csv_element(name,row,replay) - Retrieve an element from loaded csv data]]
* [[http://apmonitor.com/apm_html/apm_py.html|csv_load(server,app,filename) - Load data file]]
* [[http://apmonitor.com/apm_html/apm_py.html|csv_lookup(name,replay) - Retrieve the column number for a variable]]
March 25, 2013, at 10:44 AM by 69.169.188.188 -
Added line 22:
* [[http://apmonitor.com/apm_html/apm.py.html|csv_data(server,app,filename) - Load data file locally]]
January 17, 2013, at 12:13 AM by 69.169.188.188 -
Changed lines 9-24 from:
* [[http://apmonitor.com/apm_html/apm.py.html|apm - Send commands to the server]]
to:
* [[http://apmonitor.com/apm_html/apm.py.html|apm(server,app,aline) - Send commands to the server]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_get(server,app,filename) - Retrieve a file from the server]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_info(server,app,type,aline) - Classify a parameter or variable]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_ip(server) - Retrieve the client IP address]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_load(server,app,filename) - Load model file]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_meas(server,app,name,value) - Specify a measurement]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_option(server,app,name,value) - Set an option]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_sol(server,app) - Retrieve the solution]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_tag(server,app,name) - Retrieve an option]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_t0(server,app,mode) - Retrieve an restart file]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_web(server,app) - Open a web interface to the dashboard]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_web_root(server,app) - Open a web interface to the root directory]]
* [[http://apmonitor.com/apm_html/apm.py.html|apm_web_var(server,app) - Open a web interface to the variable values]]
* [[http://apmonitor.com/apm_html/apm.py.html|csv_element(name,row,replay) - Retrieve an element from loaded csv data]]
* [[http://apmonitor.com/apm_html/apm.py.html|csv_load(server,app,filename) - Load data file]]
* [[http://apmonitor.com/apm_html/apm.py.html|csv_lookup(name,replay) - Retrieve the column number for a variable
]]
January 17, 2013, at 12:00 AM by 69.169.188.188 -
Added lines 1-9:
(:title APM Python Interface Documentation:)
(:keywords Python, APM Python, nonlinear, model, predictive control, differential, algebraic, modeling language:)
(:description The APM Python interface enhances the numerical capabilities for optimization, simulation, estimation, and control:)

!!!! APM Python Functions

The following Python functions are available in the '''apm.py''' file available by downloading the [[Main/PythonApp|APM Python toolbox]].

* [[http://apmonitor.com/apm_html/apm.py.html|apm - Send commands to the server]]