APMonitor Documentation
Advanced process control and optimization
  • Home
  • Premium
  • Basic
  • Discussion
Main

APM Python Interface Documentation

  • View
  • Edit
  • History
  • Print

APM Python Functions

The following Python functions are available in the apm.py file available by downloading the APM Python toolbox.

  • 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
  • Documentation
  • Users
    • Overview
    • Background
    • FAQ
    • Release Notes
    • User's Group
    • Webinars
    • User Reviews
  • Download
    • APMonitor
    • IPOPT
    • MATLAB
    • Python
    • SBML
    • Command Line
    • APM Editor
    • Web Interface
  • Applications
    • Overview
    • Aerospace
      • UAVs
    • Biological
      • Cells
      • Diabetes
      • Diet
      • Measles
    • Chemical
      • Distillation
      • Blending
      • Gibbs
      • Reactor
      • Van de Vusse
    • Energy
      • Storage
      • Fuel Cell
      • Ethanol
    • Financial
      • Stocks
    • Mechanical
      • DC Motor
      • Drill Shaft
      • Electric Car
      • Oscillator
      • Pendulum
      • Shuttle
      • Suspension
    • Optimization
      • Benchmarks
      • Linear MPC
      • MPECs
      • Piecewise
      • Tutorial
  • Using APM
    • APM MATLAB
    • APM Python
    • Fixed Values
      • Constants
      • Parameters
    • Calculated Values
      • Variables
      • Algebraic
      • Differential
      • Constraints
      • Slack
      • Objective
    • Equations
      • Arrays
      • Connections
      • Intermediates
      • Equations
    • Object Elements
      • Compounds
      • Objects
  • Modes
    • Overview
    • Steady-State
      • Simulate
      • Estimate
      • Optimize
    • Dynamic
      • Simulate
      • Estimate
      • Optimize
    • Sequential
      • Simulate
  • System files
    • Overview
    • Model (apm)
    • Info (info)
    • Database (dbs)
      • Global
      • Variables
    • Data (csv)
    • Solution (t0)
  • Admin
    • Wiki Help
    • edit SideBar

Copyright © 2012, APMonitor

Delicious Digg StumbleUpon Propeller Reddit Magnoliacom Newsvine Furl Facebook Technorati
Share/Save/Bookmark
Subscribe to APMonitor Discussion Group
Email:
QR Code

Terms of Use