Editors / Validators

Software tools that allow checking the correctness of the semantic and syntactic usage of the Energistics standards in a given activity.

In order to be efficiently used for earth modeling activities, the Energistics standards must be complemented by software tools that allow checking the correctness of their semantic and syntactic usage in a given activity. For this, Geosiris has developed software applications which enable developers and end users to explore RESQML entity containers or individual entities, to verify that these data are used and organized in conformity with the standards, and to edit them so that they can be integrated into the geo-modeling workflow or possibly imported or exported in other applications.

As a plus, Geosiris is developing a migration tool from the previous RESQML release (v2.0.1) to RESQML v2.2.

RESQML Editor/Validator for RESQML v2.0.1 — “on premise”

The RESQML Editor/Validator software tool was designed to help information technology (IT) and geology, geoscience and engineering (GG&E) professionals quickly and easily explore, validate and edit RESQML data sets before importing them into their RESQML-enabled GG&E software applications.

The 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.

Content available

  • RESQML Editor/Validator Tool
  • Examples and related files (explained in the User Guide)
  • Documentation for the Editor/Validator
    • Chapter 2: Installation for the Editor/Validator Tool
    • Chapter 6: Installation for the Command Line Tool

This interactive tool is composed of a system of menus and views, described briefly below.

ViewWhat it displays
TableA tabular list of all top-level objects (TLO) in the in-memory model of an EPC file. For each object it shows content type, title and UUID.
GraphA graphical representation of objects in the in-memory model of an EPC file, showing references, hierarchy, etc.
Resource Set / Resource Set ListDisplays the details of a TLO in the in-memory model of the EPC file. To display the data for an object, in Table View, double click on the object. A Resource window opens for each object, where you can drill down on the hierarchy of data that comprises the object. The Resource View allows multiple TLOs to be open (each in a separate window) and keeps a list of open resources so you can manage them.
LogDisplays results data from the validation functions. If you run multiple validations, the results are appended to the log.
PropertiesDisplays property data for the resource that is selected in the Resource View. You can examine and edit properties.

RESQML Editor/Validator Web Studio for RESQML v2.0.1 — “cloud”

A totally redeveloped version of this tool was implemented and tested in 2020/2021 and is now available for free from the Cloud. This new version is accessible from your favorite web browser.

  • It provides a way for you to quickly and easily validate RESQML data contained in an Energistics Packaging Conventions (EPC) file, thereby ensuring its integrity before you begin using the data in a software application or technical workflow.
  • It ensures the integrity and validity of the top-level RESQML data objects contained in an EPC file, and of the relationships between these RESQML data objects.
  • It delivers interactive exploration and editing capabilities that let you work with your RESQML data (XML and HDF5) to resolve issues or, for advanced users, to create files for examples and testing.
  • It allows you to create new Energistics Entities and check their validity and consistency.
  • It ensures the EPC export.
ViewWhat it displays
TableA tabular list of all top-level objects (TLO) in the in-memory model of an EPC file. For each object it shows content type, title, UUID, version number and namespace (RESQML, WITSML).
GraphA graphical representation of objects in the in-memory model of an EPC file, showing references, hierarchy, etc.
Resource Set / Resource Set ListDisplays the details of a TLO in the in-memory model of the EPC file. To display the data for an object, in Table View, double click on the object. A Resource window opens for each object, where you can drill down on the hierarchy of data that comprises the object.
LogDisplays results data from the validation functions. If you run multiple validations, the results are appended to the log. To see the logs you need to activate the show (or hide) console button in the menu. You can clear the log view.
PropertiesDisplays property data for the resource that is selected in the Resource View. You can examine and edit properties.

RESQML Editor/Validator Web Studio dedicated to RESQML v2.2

On the base of the RESQML Web Studio previously developed for RESQML v2.0.1, Geosiris has implemented an enhanced version for the Energistics RESQML v2.2 release.

This tool authorizes user management, HDF5 and graph exploration, long term storage and management of the EPC content, and integrates all the new features of the RESQML v2.2 release.

As the previous version, this tool can import, create and export EPC files, but also integrates the capability to serve as an ETP v1.2 client to exchange information with an ETP server (like GABBRO).

In parallel, Geosiris is also setting up a mechanism to provide direct 3D visualization of geomodelling representations of the RESQML entities.

The combination of this complete set of tools (Editor/Validator v2.0.1, migration tool, and Explorer/Editor v2.2) allows all RESQML users to monitor their migration in a comfortable manner. They can have a look at the RESQML v2.0.1 information, migrate it to a RESQML v2.2 EPC and complete it by adding new information.

RESQML migration tool from v2.0.1 to v2.2

Starting from its experience gained on RESQML v2.0.1 from 2017, Geosiris has developed a migration tool to comply with RESQML v2.2. It is a Java command line executable (.jar).

It allows you to read a RESQML v2.0.1 EPC + HDF5 pair of files, understand what remains equivalent between the two versions, and execute an ad hoc transformation of the RESQML v2.0.1 EPC file to create a new RESQML v2.2 EPC file. The HDF5 file is explored to capture some meta-data information about its data arrays, but it is not modified.