Welcome to the technical resources and the specifications for the RESQML standard.
- This content is provided to help in the design, development and testing of software based on the RESQML™ standard.
- The members of the RESQML Work Group contributed time and expertise to define each version of the standard, and provide various tools to make it easier to test it and deploy it.
RESQML v2.2
Released in May 2022, RESQML™ v2.2 is the latest version of the standard. Currently, all Energistics data model standards (WITSML v2.1, PRODML v2.3, and RESQML v2.2) use the same version of Energistics common, v2.3.
- For web-based transfers, use Energistics Transfer Protocol (ETP) v1.2 as the API for RESQML v2.2.
- For file-based transfers, use Energistics Packaging Conventions (EPC) v1.1 to group related files.
- Uses Energistics common v2.3 (which is included in the download package). (Energistics common is a set of data objects shared by all Energistics domain standards.)
- Includes XML schemas (XSD). JSON schemas will be added when available.
- For a description of changes in v2.2, see the release notes in the download package.
Standard | Link |
Download data schema specification package, which includes:
| 
NOTE: JSON schemas will be added to the download package when available. |
Energistics Transfer Protocol (ETP) v1.2 API may be used with RESQML v2.2 but is downloaded separately. | |
Energistics Packaging Conventions v1.1. | |
RESQML v2.0.1
RESQML v2.0.1 DATA SCHEMAS
- Was released in 2016; it is still widely used in production including in the OSDU™ Data Platform.
- Uses Energistics common v2.0.
- Uses Energistics Packaging Conventions (EPC) v1.0.
RESQML v2.0.1 objects include:
- Activity Model. Its purpose is to capture:
- Tasks or actions that occurred to create and edit a subsurface model
- How the activities relate to the data being exchanged.
- Property Series. Makes it possible to capture the evolution of property values through time or for multiple realizations generated during stochastic processes.
- Streamlines. In a reservoir engineering context, streamlines are a way to visualize and represent fluid flow. They have many applications; for example, they have been used as a basis for fluid flow simulation, sweep management, well rate optimization, and infill well placement.
You can find on the Download Standards page packages comprising documentation and examples:
Standard | Link |
Download the Data Schema Specifications and supporting documentation - Sept 2015 | |
RESQML v2 ORIENTATION VIDEO
- Francis Morandini from Total
- Alice Chanvin-Laaouissi and Laurent Deny from Paradigm
- Jana Schey and Jay Hollingsworth from Energistics
RESQML EDITOR/VALIDATOR FOR v2.0.1
The RESQML Editor/Validator application was created to assist adoption of RESQML. This tool enables users to explore, edit and validate RESQML v2.0.1 data objects and EPC files (the "container" file used to gather related RESQML data objects and other files for exchange among software packages). Also available is a Command Line Validator, which may be integrated with RESQML-enabled software, to run automatically when RESQML data is imported. The following may be downloaded from Download Standards.
- RESQML Editor/Validator Tool
- Examples and related files (explained in User Guide)
- Documentation for the Editor/Validator
- Chapter 2: Installation for the Editor/Validator Tool
- Chapter 6: Installation for the Command Line Tool
You can find on the Download Standards page, packages comprising the Editor/Validator for v2.0.1.
Description | Link |
RESQML Editor/Validator for v2.0.1 and Command Line Validator plus Documentation and Examples - October 2017 | |
HDF5
RESQML v2.0.1 includes use of a standard binary file format called HDF5 for transmission of large amounts of data. This standard is developed and maintained by HDF Group. HDF5 libraries compatible with the RESQML standard may be downloaded from HDF Group. .NET:
C/C++/Fortran: https://support.hdfgroup.org/ftp/HDF5/releases/hdf5-1.8/hdf5-1.8.9/bin Java: http://www.hdfgroup.org/products/java/release/download.html#download It is important to use version 1.8.18* or higher within the 1.8.x series. Java, .NET and Python users should check wrapper for an appropriate version. It is recommended not to migrate to the 1.10.x series at this time but if it is determined that 1.10.x is needed, please send a note to Energistics explaining the rationale for further research. * NOTE: Security issues have been identified for versions before 1.8.18. More information from HDF Group. Use of HDF5 for RESQML is authorized by HDF Group under their license agreement.
Example RESQML XML data You can find on the Download Standards page packages comprising documentation and examples, in addition to an Editor/Validator for v2.0.1.
Description | Link |
RESQML Editor/Validator for v2.0.1 and Command Line Validator plus Documentation and Examples - October 2017 | |
RESQML Version History
RESQML v1.1 and all prior versions have been deprecated and are no longer supported.