Welcome to the technical resources and the specifications for the RESQML standard. This material is provided to help in the design, development and testing of software based on the RESQML standard. The members of the RESQML SIG have contributed a lot of time and effort over the years to build consensus around each version of the standards, as well as make available various tools to make it easier to build software based on the standards, test it and deploy it.
RESQML Version 2.0.1
Version 2.0.1 was released in 2016, and it is the current version of the RESQML standard. It should be used for all new developments.
RESQML Version history
- Version 1.1 (2011) is still in use, and it is currently supported by Energistics
- Prior versions are deprecated. Contact Energistics at email@example.com if you need to access legacy documents.
RESQML Development tools
The following resources are available for developers:
- Software Development Kits (SDKs): SDK kit for Java and .NET object wraps
- Sample datasets: these allow developers to test new or modified software
- Energistics Online: a comprehensive interactive documentation system for version 2.0 and later
There is currently no certification process for RESQML.
Collaboration with other standards organizations
There are currently no collaboration projects for RESQML
RESQML combines with:
- Energistics Transfer Protocol (ETP), a new standard to accelerate and smooth the transfer of real-time data
- Energy Industry Profile for Metadata
Licensing & Legal
Click here to access the information regarding licensing, intellectual property, trademarks and other legal information for companies intending to develop and deploy software using the Energistics Standards
RESQML version 2.0.1
RESQML VERSION 2.0.1
NOTE: v2.0.1 is the current version of RESQML, recommended for implementation in production.
V2.0.1 adds the new data objects and capabilities listed below to RESQML v2.0 (published in September 2014). Note, the v2.0 model is exactly as published previously; the new data objects have simply been added. As such, the new objects are contained in their own packages of the RESQML UML data model (EAP file) and documented in appendices of existing RESQML documents.
New 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.
|Download the Data Schema Specifications and supporting documentation – Sept 2015|
|Download the RESQML Editor/Validator for v2.0.1 and Command Line Validator plus Associated Documentation and Examples – October 2017|
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
RESQML V2.0 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.
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.
RESQML Version History
RESQML VERSION 1.1 SPECIFICATIONS
|Browse the Data Schema Specifications v1.1 – October 2011||Data Schema|
|Download the Data Schema Specifications v1.1|
NOTE: Version 1.1 is the previous commercial implementation. v1.0 was a development version and has been removed from the website. If v1.0 schema or guides are needed, please contact firstname.lastname@example.org.
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.
|RESQML Editor/Validator for v2.0.1 and Command Line Validator plus Documentation and Examples – October 2017|
RESQML Development Tools
The Standards DevKit is designed so a developer can concentrate on integrating these standards into their business solution.It was developed by ExxonMobil and is now maintained by Energistics. It wraps WITSML, RESQML and PRODML schemas with Microsoft .NET objects. Go to page
RESQML V2.0 Proxy Generator
Access to FESAPI material is here. Source code and documentation, developed by F2I-Consulting, are provided “as is”, without any implied warranty of any kind. Anyone is free to use, modify and redistribute at their own risk.
This project provides RESQML import functionality to ParaView. This mainly enables the ability to easily display RESQML data in a well-known and robust 3D viewer. Because this plug-in basically converts RESQML data into VTK data, all ParaView filters can be used on imported RESQML data. This plug-in also provides a tree view of the content of an EPC document and can show metadata associated to RESQML data.
Access to FESPP is here. Source code and documentation, developed by F2I-Consulting, are provided “as is”, without any implied warranty of any kind. Anyone is free to use, modify and redistribute at their own risk.
Collaborations with Standards Organizations
There are no collaboration projects in place at this point in time for RESQML.
RESQML Server Certification
There is no certification process for RESQML servers at this point in time.