RESQML Developers & Users

RESQML Developers & Users2018-12-14T15:33:29+00:00

Overview

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

RESQML Development tools

The following resources are available for developers:

RESQML Certification

There is currently no certification process for RESQML.

Collaboration with other standards organizations

There are currently no collaboration projects for RESQML

Related standards

RESQML combines with:

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.
Standard Link
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

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.  Click here to view video 
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

HDF5

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.

.NET:

C/C++/Fortran:
http://www.hdfgroup.org/ftp/HDF5/releases/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 Version History

RESQML VERSION 1.1 SPECIFICATIONS

RESQML v1,1 Overview

Standard Link
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 standards@energistics.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.

Description Link
RESQML Editor/Validator for v2.0.1 and Command Line Validator plus Documentation and Examples – October 2017

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

RESQML Development Tools

Standards DevKit

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

An XML proxy generator converts XML schema definition (XSD) files into classes of a given programming language. This specific proxy generator turns RESQML2 v2.0 XSD files into C++ classes. In addition, the proxy generator creates an API to manipulate sets of top-level objects, represent EPC relationships and compress to ZIP files.  resqml v2 proxy generator
Source code and documentation, developed by Chevron and donated to Energistics, are provided “as is”, without any implied warranty of any kind. Anyone is free to use, modify and redistribute at their own risk.

FESAPI

This project provides C++ classes which allow easy access for importing and exporting Energistics standards. only RESQML v2 (including EPC) is currently supported but support for ETP, WITSML v2 and PRODML v2 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 applciations (and perhaps other languages in the future such as Python, Javascript, etc.)  FESAPI

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.

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 sued 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.  FESPP

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.