evo-data-converters-resqml 0.1.4
Python data converters for RESQML to Evo geoscience objects
Requires Python: >=3.10

<p align="center"><a href="https://seequent.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://developer.seequent.com/img/seequent-logo-dark.svg" alt="Seequent logo" width="400" /><img src="https://developer.seequent.com/img/seequent-logo.svg" alt="Seequent logo" width="400" /></picture></a></p>
<p align="center">
    <a href="https://pypi.org/project/evo-data-converters-resqml/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-data-converters-resqml" /></a>
    <a href="https://github.com/SeequentEvo/evo-data-converters/actions/workflows/on-merge.yaml"><img src="https://github.com/SeequentEvo/evo-data-converters/actions/workflows/on-merge.yaml/badge.svg" alt="" /></a>
</p>
<p align="center">
    <a href="https://developer.seequent.com/" target="_blank">Seequent Developer Portal</a>
    &bull; <a href="https://community.seequent.com/group/19-evo" target="_blank">Seequent Community</a>
    &bull; <a href="https://seequent.com" target="_blank">Seequent website</a>
</p>

## Evo

Evo is a unified platform for geoscience teams. It enables access, connection, computation, and management of subsurface data. This empowers better decision-making, simplified collaboration, and accelerated innovation. Evo is built on open APIs, allowing developers to build custom integrations and applications. Our open schemas, code examples, and SDK are available for the community to use and extend. 

Evo is powered by Seequent, a Bentley organisation.

## Pre-requisites

* Python 3.10, 3.11, or 3.12

## Installation

```shell
pip install evo-data-converters-resqml
```

## RESQML

RESQML is an XML based standard for geoscience data.

Refer here for more information: https://www.energistics.org/resqml-data-standards/

To work with RESQML files [the `resqpy` Python package](https://pypi.org/project/resqpy/) is used.

## Usage

For examples of using this package, see the [Jupyter notebooks.](https://github.com/SeequentEvo/evo-data-converters/tree/main/packages/resqml/samples/convert-resqml)

### Limitations

Processing a large amount of grid data can consume a lot of memory due to the `grid.corner_points` array getting very large.

To protect against this there is a `memory_threshold` setting in [conversion_options.py](https://github.com/SeequentEvo/evo-data-converters/tree/main/packages/resqml/src/evo/data_converters/resqml/importer/conversion_options.py). Grids will only be converted if the estimated size of `grid.corner_points` is less than the threshold. The default is 8 GiB but this can be increased if you have more memory available where the importer is running.

## Code of conduct

We rely on an open, friendly, inclusive environment. To help us ensure this remains possible, please familiarise yourself with our [code of conduct.](https://github.com/SeequentEvo/evo-data-converters/blob/main/CODE_OF_CONDUCT.md)

## License
Evo data converters are open source and licensed under the [Apache 2.0 license.](https://github.com/SeequentEvo/evo-data-converters/tree/main/packages/resqml/./LICENSE.md)

Copyright © 2025 Bentley Systems, Incorporated.

Licensed under the Apache License, Version 2.0 (the "License").
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.