💧
OLI API
  • Welcome to the OLI API documentation
  • Basic workflow
  • Authentication
    • Bearer Token
    • API Keys
      • Generate a Key
      • List All Keys
      • Delete a Key
  • Generating chemistry model files
    • ChemBuilder API
      • Getting Started with ChemBuilder
        • Set Thermodynamic Framework
        • Include Private Databanks
        • Include Inflows
          • Include Assays
          • Include Pseudocomponent
        • Choose Phases
        • Specify Model Name
        • Choose Redox
        • Choose Solids
        • Add Kinetics
      • ChemBuilder Query
        • Species Query
        • Redox Query
        • Solid Phase Query
        • Databank Query
        • Kinetics Query
        • Query Output Results
      • Supporting Information for ChemBuilder
        • Add Comment
        • "enabled" Keyword
        • ChemBuilder Errors
    • Chemistry Wizard
  • Uploading chemistry model files
  • Get list of uploaded files
  • Quickstart example: Python
  • Known issues and Limitations
  • OLI ENGINE API
    • Main methods
      • API call blueprint
      • Chemistry information
      • Isothermal flash
      • Isenthalpic flash
      • Bubble point flash
      • Dew point flash
      • Vapor amount flash
      • Vapor fraction flash
      • Isochoric flash
      • set pH flash
      • Precipitation point flash
      • Autoclave
      • Custom flash
      • Corrosion contact surfaces
      • Corrosion rates
      • Water analysis
  • Additional methods
    • Flash history - Chemistry model
    • Result - by jobId
    • delete file
    • cancel run
  • Inflows input
  • Optional inputs
  • Kinetic calculation inputs
  • Kinetic calculation outputs
  • Input units
  • User defined output unit set
  • Survey calculation
  • Stream output
  • Error/Warning output
  • Definition of terms
  • OLI Process API
    • Uploading a Process API package
      • Creating a Process API package
    • Get list of all uploaded ProcessAPI packages
    • Get input specs for Process API package
    • Get output specs for ProcessAPI package
    • Run a Process API calculation
    • Get calculation status and results
  • Deleting a process package
  • Undelete a process package
  • Process API input specification
    • "data" object
      • "flowsheet" object
        • "chemical-info" object
        • "general-info" object
        • "properties" object
        • "units_set_info" object
  • OLI ScaleChem API
    • Uploading chemistry model files for ScaleChem API
    • Get list of uploaded ScaleChem model files
    • Main methods
      • Brine analysis
      • Gas analysis
      • Oil analysis
      • Mixer calculation
      • Scale scenario
Powered by GitBook
On this page
  • Known issues
  • Limitations

Was this helpful?

Known issues and Limitations

Known issues

  • JSON input passed as input in http body needs to be UTF-8 encoded. If not this could cause undefined behavior.

  • Values for unit entries need to be specified as given in this document. Error in this input could cause undefined behavior. This issue is being resolved at the moment

  • Currently, in some unusual cases, there may be some discrepancy between units chosen for output and the units that are actually used.

  • When an equilibrium calculation fails or when there is bad user input, there could be cases when the http response status could be still be 200 OK. Please verify the data object to be sure i.e. error object or result object. The data object will contain information on the state of the last call

Limitations

  • Currently there is no way to generate a chemistry model file(.dbs) directly with the cloud API(s). This capability is currently in development.

  • Currently the cloud API(s) do not support ScaleChem specific calculations. This capability is currently in development.

  • Batch calculations on the same chemistry model are not supported. The user would have to issue individual requests for each calculation

  • System limits:

    • max queue: Maximum number of calculations that can be queued

    • max concurrency: Maximum simultaneous calculations that can be performed

  • In the event that an computation engine crash occurs, the backend could take up to 1 minute to respond to the error during the polling cycle.

PreviousQuickstart example: PythonNextMain methods

Last updated 4 years ago

Was this helpful?