[](https://github.com/tkarabela/ensight-reader/actions)
[](https://app.codecov.io/github/tkarabela/ensight-reader)
[](https://github.com/tkarabela/pysubs2/actions)
# ensight-reader
This library provides a pure Python reader (with some writing capability) for the EnSight Gold data format,
a common format for results of computational fluid dynamics (CFD) simulations.
It also comes with a few CLI tools, notably `ensight_transform` which
allows you to perform in-place scaling/translation/etc. of the geometry in your case.
The library designed for efficient, selective, memory-mapped access to data from EnSight Gold case –
something that would be useful when importing the data into other systems. If you're looking for a more "batteries included" solution, look at
[`vtkEnSightGoldBinaryReader`](https://vtk.org/doc/nightly/html/classvtkEnSightGoldBinaryReader.html)
from the VTK library ([see docs for comparison](https://ensight-reader.readthedocs.io/en/latest/design-howto.html#comparison-with-vtk-library)).
### Requirements
- Python 3.9+
- NumPy 1.21+
### Installation
```sh
pip install ensight-reader
```
### Example – Python API
```python
import ensightreader
import numpy as np
case = ensightreader.read_case("example.case")
geofile = case.get_geometry_model()
part_names = geofile.get_part_names() # ["internalMesh", ...]
part = geofile.get_part_by_name(part_names[0])
N = part.number_of_nodes
with geofile.open() as fp_geo:
node_coordinates = part.read_nodes(fp_geo) # np.ndarray((N, 3), dtype=np.float32)
variable = case.get_variable("UMean")
with variable.mmap_writable() as mm_var:
data = variable.read_node_data(mm_var, part.part_id)
data[:] = np.sqrt(data) # transform variable data in-place
```
### Example – CLI
```sh
# increment X coordinate
ensight_transform --translate 1 0 0 sphere.case
# scale by 1000 (eg. m -> mm conversion)
ensight_transform --scale 1e3 1e3 1e3 sphere.case
# rotation matrix
ensight_transform --matrix \
0 -1 0 0 \
1 0 0 0 \
0 0 1 0 \
0 0 0 1 \
sphere.case
# transform only "internalMesh" part
ensight_transform --translate 1 0 0 --only-parts internalMesh motorbike.case
```
To learn more, please [see the documentation](https://ensight-reader.readthedocs.io).
Raw data
{
"_id": null,
"home_page": "https://github.com/tkarabela/ensight-reader",
"name": "ensight-reader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Tomas Karabela",
"author_email": "tkarabela@seznam.cz",
"download_url": "https://files.pythonhosted.org/packages/eb/23/ebc133517894b9b498543da91647b60a78371606a327abf1200732de6b31/ensight_reader-0.11.2.tar.gz",
"platform": null,
"description": "[](https://github.com/tkarabela/ensight-reader/actions)\n[](https://app.codecov.io/github/tkarabela/ensight-reader)\n[](https://github.com/tkarabela/pysubs2/actions)\n\n\n\n\n\n# ensight-reader\n\nThis library provides a pure Python reader (with some writing capability) for the EnSight Gold data format,\na common format for results of computational fluid dynamics (CFD) simulations.\nIt also comes with a few CLI tools, notably `ensight_transform` which\nallows you to perform in-place scaling/translation/etc. of the geometry in your case.\n\nThe library designed for efficient, selective, memory-mapped access to data from EnSight Gold case \u2013\nsomething that would be useful when importing the data into other systems. If you're looking for a more \"batteries included\" solution, look at\n[`vtkEnSightGoldBinaryReader`](https://vtk.org/doc/nightly/html/classvtkEnSightGoldBinaryReader.html)\nfrom the VTK library ([see docs for comparison](https://ensight-reader.readthedocs.io/en/latest/design-howto.html#comparison-with-vtk-library)).\n\n### Requirements\n\n- Python 3.9+\n- NumPy 1.21+\n\n### Installation\n\n```sh\npip install ensight-reader\n```\n\n### Example \u2013 Python API\n\n```python\nimport ensightreader\nimport numpy as np\n\ncase = ensightreader.read_case(\"example.case\")\ngeofile = case.get_geometry_model()\n\npart_names = geofile.get_part_names() # [\"internalMesh\", ...]\npart = geofile.get_part_by_name(part_names[0])\nN = part.number_of_nodes\n\nwith geofile.open() as fp_geo:\n node_coordinates = part.read_nodes(fp_geo) # np.ndarray((N, 3), dtype=np.float32)\n\nvariable = case.get_variable(\"UMean\")\n\nwith variable.mmap_writable() as mm_var:\n data = variable.read_node_data(mm_var, part.part_id)\n data[:] = np.sqrt(data) # transform variable data in-place\n```\n\n### Example \u2013 CLI\n\n```sh\n# increment X coordinate\nensight_transform --translate 1 0 0 sphere.case\n\n# scale by 1000 (eg. m -> mm conversion)\nensight_transform --scale 1e3 1e3 1e3 sphere.case\n\n# rotation matrix\nensight_transform --matrix \\\n 0 -1 0 0 \\\n 1 0 0 0 \\\n 0 0 1 0 \\\n 0 0 0 1 \\\n sphere.case\n\n# transform only \"internalMesh\" part\nensight_transform --translate 1 0 0 --only-parts internalMesh motorbike.case\n```\n\nTo learn more, please [see the documentation](https://ensight-reader.readthedocs.io).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A pure Python reader for the EnSight Gold format",
"version": "0.11.2",
"project_urls": {
"Bug Tracker": "https://github.com/tkarabela/ensight-reader/issues",
"Documentation": "https://ensight-reader.readthedocs.io",
"Homepage": "https://github.com/tkarabela/ensight-reader"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "998f689f826973cb567e8cf1ebaa6c6ca533513867386f7b985fc61c2838fcff",
"md5": "8c2f87922fe98689c7272a29eea64099",
"sha256": "b39ece40f29c5fc16cb651cea3dc578911c73e9ee26de25f8518d8d0904dcba5"
},
"downloads": -1,
"filename": "ensight_reader-0.11.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8c2f87922fe98689c7272a29eea64099",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25894,
"upload_time": "2024-06-21T20:24:29",
"upload_time_iso_8601": "2024-06-21T20:24:29.206771Z",
"url": "https://files.pythonhosted.org/packages/99/8f/689f826973cb567e8cf1ebaa6c6ca533513867386f7b985fc61c2838fcff/ensight_reader-0.11.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb23ebc133517894b9b498543da91647b60a78371606a327abf1200732de6b31",
"md5": "b2d27d5a1efc8e0d254dd420768c60aa",
"sha256": "364fcc4f8ccf1c195455c62641eaf921ff4ba14994c46eb1c46d305bee8aec63"
},
"downloads": -1,
"filename": "ensight_reader-0.11.2.tar.gz",
"has_sig": false,
"md5_digest": "b2d27d5a1efc8e0d254dd420768c60aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 29197,
"upload_time": "2024-06-21T20:24:30",
"upload_time_iso_8601": "2024-06-21T20:24:30.973949Z",
"url": "https://files.pythonhosted.org/packages/eb/23/ebc133517894b9b498543da91647b60a78371606a327abf1200732de6b31/ensight_reader-0.11.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 20:24:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tkarabela",
"github_project": "ensight-reader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ensight-reader"
}
JSON
