Main

APM Python Interface Documentation

Main.PythonFunctions History

Hide minor edits - Show changes to markup

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 18, 2014, at 02:13 AM by 107.188.175.164 -
Changed lines 9-25 from:
  • apm(server,app,aline) - Send commands to the server
  • apm_get(server,app,filename) - Retrieve a file from the server
  • apm_info(server,app,type,aline) - Classify a parameter or variable
  • apm_ip(server) - Retrieve the client IP address
  • apm_load(server,app,filename) - Load model file
  • apm_meas(server,app,name,value) - Specify a measurement
  • apm_option(server,app,name,value) - Set an option
  • apm_sol(server,app) - Retrieve the solution
  • apm_tag(server,app,name) - Retrieve an option
  • apm_t0(server,app,mode) - Retrieve an restart file
  • apm_web(server,app) - Open a web interface to the dashboard
  • apm_web_root(server,app) - Open a web interface to the root directory
  • apm_web_var(server,app) - Open a web interface to the variable values
  • csv_data(server,app,filename) - Load data file locally
  • csv_element(name,row,replay) - Retrieve an element from loaded csv data
  • csv_load(server,app,filename) - Load data file
  • csv_lookup(name,replay) - Retrieve the column number for a variable
to:
  • apm(server,app,aline) - Send commands to the server
  • apm_get(server,app,filename) - Retrieve a file from the server
  • apm_info(server,app,type,aline) - Classify a parameter or variable
  • apm_ip(server) - Retrieve the client IP address
  • apm_load(server,app,filename) - Load model file
  • apm_meas(server,app,name,value) - Specify a measurement
  • apm_option(server,app,name,value) - Set an option
  • apm_sol(server,app) - Retrieve the solution
  • apm_tag(server,app,name) - Retrieve an option
  • apm_t0(server,app,mode) - Retrieve an restart file
  • apm_web(server,app) - Open a web interface to the dashboard
  • apm_web_root(server,app) - Open a web interface to the root directory
  • apm_web_var(server,app) - Open a web interface to the variable values
  • csv_data(server,app,filename) - Load data file locally
  • csv_element(name,row,replay) - Retrieve an element from loaded csv data
  • csv_load(server,app,filename) - Load data file
  • csv_lookup(name,replay) - Retrieve the column number for a variable
March 25, 2013, at 04:44 PM by 69.169.188.188 -
Added line 22:
  • csv_data(server,app,filename) - Load data file locally
January 17, 2013, at 07:13 AM by 69.169.188.188 -
Changed lines 9-24 from:
  • apm - Send commands to the server
to:
  • apm(server,app,aline) - Send commands to the server
  • apm_get(server,app,filename) - Retrieve a file from the server
  • apm_info(server,app,type,aline) - Classify a parameter or variable
  • apm_ip(server) - Retrieve the client IP address
  • apm_load(server,app,filename) - Load model file
  • apm_meas(server,app,name,value) - Specify a measurement
  • apm_option(server,app,name,value) - Set an option
  • apm_sol(server,app) - Retrieve the solution
  • apm_tag(server,app,name) - Retrieve an option
  • apm_t0(server,app,mode) - Retrieve an restart file
  • apm_web(server,app) - Open a web interface to the dashboard
  • apm_web_root(server,app) - Open a web interface to the root directory
  • apm_web_var(server,app) - Open a web interface to the variable values
  • csv_element(name,row,replay) - Retrieve an element from loaded csv data
  • csv_load(server,app,filename) - Load data file
  • csv_lookup(name,replay) - Retrieve the column number for a variable
January 17, 2013, at 07: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 APM Python toolbox.

  • apm - Send commands to the server