| Name | resqpy JSON |
| Version |
4.14.4
JSON |
| download |
| home_page | https://github.com/bp/resqpy |
| Summary | Python API for working with RESQML models |
| upload_time | 2024-04-21 15:52:20 |
| maintainer | None |
| docs_url | None |
| author | BP |
| requires_python | <3.12,>=3.8.1 |
| license | MIT |
| keywords |
resqml
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# resqpy: Python API for working with RESQML models
[](https://github.com/bp/resqpy/blob/master/LICENSE)
[](https://resqpy.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/bp/resqpy/actions/workflows/ci-tests.yml)
[](https://badge.fury.io/py/resqpy)
[](https://codecov.io/gh/bp/resqpy)
## Introduction
**resqpy** is a pure Python package which provides a programming interface (API) for
reading, writing, and modifying reservoir models in the RESQML format. It gives
you the ability to work with reservoir models programmatically, without having
to know the details of the RESQML standard.
The package is written and maintained by bp, and is made available under the MIT
license as a contribution to the open source community.
**resqpy** was created by Andy Beer. For enquires about resqpy, please contact
Emma Nesbit (Emma.Nesbit@uk.bp.com)
### Documentation
See the complete package documentation on
[readthedocs](https://resqpy.readthedocs.io/).
### About RESQML
RESQML™ is an industry initiative to provide open, non-proprietary data exchange
standards for reservoir characterization, earth and reservoir models. It is
governed by the [Energistics
consortium](https://www.energistics.org/portfolio/resqml-data-standards/).
Resqpy provides specialized classes for a subset of the RESQML high level object
classes, as described in the docs. Furthermore, not all variations of these
object types are supported; for example, radial IJK grids are not yet catered
for, although the RESQML standard does allow for such grids.
It is envisaged that the code base will be expanded to include other classes of
object and more fully cover the options permitted by the RESQML standard.
## Installation
Resqpy can be installed with pip:
```bash
pip install resqpy
```
Alternatively, to install your working copy of the code in "editable" mode:
```bash
pip install -e /path/to/repo/
```
## Contributing
Contributions of all forms are welcome and encouraged! Please feel free to open
issues on the GitHub issue tracker, or submit Pull Requests. Instructions with how to set up your own development environment can be found at [Development environment setup](https://github.com/bp/resqpy/blob/master/docs/CONTRIBUTING.rst#development-environment-setup). Please read the
[Contributing Guide](docs/CONTRIBUTING.rst) before submitting patches.
Raw data
{
"_id": null,
"home_page": "https://github.com/bp/resqpy",
"name": "resqpy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8.1",
"maintainer_email": null,
"keywords": "RESQML",
"author": "BP",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e2/75/0415df915f6865812c3609f09e2014dd7f970332db6f56dd23038a3cba43/resqpy-4.14.4.tar.gz",
"platform": null,
"description": "# resqpy: Python API for working with RESQML models\n\n[](https://github.com/bp/resqpy/blob/master/LICENSE)\n[](https://resqpy.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/bp/resqpy/actions/workflows/ci-tests.yml)\n\n[](https://badge.fury.io/py/resqpy)\n\n[](https://codecov.io/gh/bp/resqpy)\n\n## Introduction\n\n**resqpy** is a pure Python package which provides a programming interface (API) for\nreading, writing, and modifying reservoir models in the RESQML format. It gives\nyou the ability to work with reservoir models programmatically, without having\nto know the details of the RESQML standard.\n\nThe package is written and maintained by bp, and is made available under the MIT\nlicense as a contribution to the open source community.\n\n**resqpy** was created by Andy Beer. For enquires about resqpy, please contact\nEmma Nesbit (Emma.Nesbit@uk.bp.com)\n\n### Documentation\n\nSee the complete package documentation on\n[readthedocs](https://resqpy.readthedocs.io/).\n\n### About RESQML\n\nRESQML\u2122 is an industry initiative to provide open, non-proprietary data exchange\nstandards for reservoir characterization, earth and reservoir models. It is\ngoverned by the [Energistics\nconsortium](https://www.energistics.org/portfolio/resqml-data-standards/).\n\nResqpy provides specialized classes for a subset of the RESQML high level object\nclasses, as described in the docs. Furthermore, not all variations of these\nobject types are supported; for example, radial IJK grids are not yet catered\nfor, although the RESQML standard does allow for such grids.\n\nIt is envisaged that the code base will be expanded to include other classes of\nobject and more fully cover the options permitted by the RESQML standard.\n\n## Installation\n\nResqpy can be installed with pip:\n\n```bash\npip install resqpy\n```\n\nAlternatively, to install your working copy of the code in \"editable\" mode:\n\n```bash\npip install -e /path/to/repo/\n```\n\n## Contributing\n\nContributions of all forms are welcome and encouraged! Please feel free to open\nissues on the GitHub issue tracker, or submit Pull Requests. Instructions with how to set up your own development environment can be found at [Development environment setup](https://github.com/bp/resqpy/blob/master/docs/CONTRIBUTING.rst#development-environment-setup). Please read the\n[Contributing Guide](docs/CONTRIBUTING.rst) before submitting patches.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python API for working with RESQML models",
"version": "4.14.4",
"project_urls": {
"Documentation": "https://resqpy.readthedocs.io/en/latest/",
"Homepage": "https://github.com/bp/resqpy",
"Repository": "https://github.com/bp/resqpy"
},
"split_keywords": [
"resqml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b364146018eaab15aa93995f7b367eb115bf2ff687546942d2ff13a0ae4c67f3",
"md5": "fcd369ef2e36ab831fd1a0b5c598f920",
"sha256": "33f504775c9ab87c2f330fac5a9352dafb38700afc7a9365d77d789ab9d5622c"
},
"downloads": -1,
"filename": "resqpy-4.14.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fcd369ef2e36ab831fd1a0b5c598f920",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8.1",
"size": 845266,
"upload_time": "2024-04-21T15:52:17",
"upload_time_iso_8601": "2024-04-21T15:52:17.831143Z",
"url": "https://files.pythonhosted.org/packages/b3/64/146018eaab15aa93995f7b367eb115bf2ff687546942d2ff13a0ae4c67f3/resqpy-4.14.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2750415df915f6865812c3609f09e2014dd7f970332db6f56dd23038a3cba43",
"md5": "4df77c3560efb389c0bd83d8ff93ec0b",
"sha256": "088d7a59f4cd290ec5665003ff861daec960086994bb82301f8d8ef82d33db8b"
},
"downloads": -1,
"filename": "resqpy-4.14.4.tar.gz",
"has_sig": false,
"md5_digest": "4df77c3560efb389c0bd83d8ff93ec0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8.1",
"size": 719636,
"upload_time": "2024-04-21T15:52:20",
"upload_time_iso_8601": "2024-04-21T15:52:20.613290Z",
"url": "https://files.pythonhosted.org/packages/e2/75/0415df915f6865812c3609f09e2014dd7f970332db6f56dd23038a3cba43/resqpy-4.14.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-21 15:52:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bp",
"github_project": "resqpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "resqpy"
}
