💧
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
  • What is a chemistry model file?
  • Generating a chemistry model file

Was this helpful?

Generating chemistry model files

What is a chemistry model file?

The chemistry model file contains the chemical components and the associated thermodynamic parameters that the user has selected for their system. The OLI Software database contains several thousand species and several hundred thousand parameters. The user will be interested in only a portion of these, and so a subset of this database to run the calculation. This "subset" is called the Chemistry Model. As the user chooses, for example NaCl, acetone and hexane as inflows, the software retrieves the relevant species and parameters and places them into this file. It has the extension of .dbs or .pkg. The file is updated each time a new component is added or if one is removed. The chemistry model file essentially encapsulates all of the chemistry data based on the chosen thermodynamic framework, inflows and other settings.

Generating a chemistry model file

In order to run any of the OLI calculations right now the user needs to first obtain a chemistry model file. Currently, the chemistry model files can be generated using one of the following methods:

API Suite
Chemistry Generation Method
File Extension

OLI Engine API

  1. ChemBuilder API

  2. OLI Studio Export

  3. OLI Chemistry Wizard

.dbs

OLI Corrosion API

  1. ChemBuilder API

  2. OLI Studio Export

  3. OLI Chemistry Wizard

.dbs

OLI Process API

  1. OLI Flowsheet:ESP Export

  2. Direct Upload from OLI Flowsheet:ESP

.pkg

OLI ScaleChem API

  1. ChemBuilder API

  2. OLI ScaleChem Export

  3. OLI Chemistry Wizard

.dbs or .pkg

Note: The OLI ScaleChem API calculation may require multiple .dbs files. In these instances, the files should be compressed into a single .zip archive, renamed with a .pkg extension, and uploaded to the ScaleChem chemistry upload endpoint.

PreviousDelete a KeyNextChemBuilder API

Last updated 11 months ago

Was this helpful?