Overview

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 contribute time and expertise to define each version of the standard, and provide various tools to make it easier to deploy (in software) and test it.

Current Version: RESQML v2.0.1

Version 2.0.1 was released in 2016, and it is the current version.  It should be used for all new developments.

RESQML v2.0.1 combines with common components of the Energistics Common Technical Architecture (CTA) on which all Energistics standards v2.0 and above are built:

RESQML Development tools

The following resources are available for developers:

  • Software Development Kits (SDKs): SDK kit for Java and .NET object wraps
  • FESAPI™ provides C++ and C# classes to simplify developments
  • Sample datasets: these allow developers to test new or modified software
  • Energistics Online: a comprehensive interactive documentation system for version 2.0 and later

RESQML Certification

There is currently no certification process for RESQML.

Collaboration with other standards organizations

Energistics works with other organizations to explore new capabilities that promote a broader use of standards:

  • Integration of Energistics standards in the Open Subsurface Data Universe (OSDU) platform

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 info@energistics.org if you need to access legacy documents

Licensing & Legal

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 click here .

Current Version – RESQML v2.0.1

RESQML v2.0.1 DATA SCHEMAS

This is the preferred version for new and upgraded production implementations.

RESQML Version 2.0.1 leverages the Energistics Common Technical Architecture (CTA), which delivers a common technology foundation for the Energistics domain standards—which includes WITSML, PRODML, and RESQML.  This common architecture makes it easier for companies to implement the standards. It also makes it easier to share data “across” the standards for integrated operations workflows.  For example, RESQML and PRODML can leverage well data in WITSML.

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

Big Data Transfers are Getting Easier Thanks to RESQML
Moving massive data sets into multiple applications has always been time consuming and difficult.  Today with the use of Energistics’ RESQML open format standard, this task is becoming easier.  To view the video, click here. 
This demonstration features:
  • 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.

RESQML Development Tools

Standards DevKit

The Standards DevKit is designed so a developer can concentrate on integrating Energistics standards into their business solution.  It wraps WITSML, RESQML and PRODML schemas with Microsoft .NET objects. Go to page

FESAPI

This project provides C++ classes which allow easy access for importing and exporting Energistics standards. Only RESQML v2.0.1 (including EPC) is currently supported but support for ETP, WITSML v2.0 and PRODML v2.0 are planned for the future. The C++ classes are constructed on top of gSOAP classes which allow easy XML serialization and deserialization. They are also associated to HDF5 libraries for importing and exporting numerical values into efficient binary files as the Energistics standards specify. Finally, this project comes with some SWIG wrappers in order to expose the C++ classes to .NET or JAVA applications (and perhaps other languages in the future such as Python, Javascript, etc.)

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. A white paper summarizes this information.

FESPP

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.

Datasets

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

Third Party Datasets

Equinor has made available the entire data for the Volve field decommissioned in 2018. It is accessible on their website here
More on this data set here

Documentation

Energistics Online is a comprehensive interactive documentation system for version 2.0.1.

Collaboration with Standards Organizations

Integration of Energistics Standards into the OSDU Platform

BACKGROUND

Energistics was invited to join the OSDU forum in October 2018, the first non-operator to officially become a member. From the beginning, OSDU experts have stated their intent to use existing standards for data schemas within the platform.

Energistics members and staff actively participate in a number of the committees across a number of topics.

OSDU INITIATIVES RELATED TO RESQML

Reservoir and subsurface data are part of the development plans for the OSDU platform, and RESQML will play an important part when that capability is added.

RESQML Version History

RESQML v1.1

The information provided here is for developers and users who are working with an existing system based on version 1.1 and require resources for maintenance and operation. Version 2.0.1 should be used for new developments.

RESQML v1,1 Overview

Standard Link
Browse the Data Schema Specifications v1.1 – October 2011 Data Schema
Request the Data Schema Specifications v1.1