[![CI with install](https://github.com/fusion-energy/openmc_cell_segmenter/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/openmc_cell_segmenter/actions/workflows/ci_with_install.yml)
# Segments OpenMC cells into smaller cells.
Specify the type of segmentation pane desired (XPlane, YPlane, ZPlane or ZCylinder) and the number of segments and obtain segmented cells.
# Install
You will need to have OpenMC installed then you can use pip to install this package.
```bash
pip install openmc-cell-segmenter
```
# Example scripts
Example Python scripts can be found in the [examples folder](https://github.com/fusion-energy/openmc_cell_segmenter/tree/main/example).
# Example outputs
In this animation we see an S shaped cell that has been segmented first with XPlanes, YPlanes, ZPlanes and ZCylinders colored by cell.
![openmc cell segmented zplane](https://user-images.githubusercontent.com/8583900/268407842-6e8783b4-1bc6-443e-ab01-ec390ae3dfe2.gif)
# Motivation
Cell segmentation has a variety of use cases.
However, this package was originally made for redefining CSG geometry for cell based shutdown dose rate simulations where separate cells are needed to capture the variation in neutron activation across large cells.
Raw data
{
"_id": null,
"home_page": "",
"name": "openmc-cell-segmenter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python,geometry,openmc",
"author": "The Openmc Cell Segmenter Development Team",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f6/77/746190d68e9fa02d2fc2b8f2f343ead879562c66903fe24d8ee1aa09d852/openmc_cell_segmenter-0.1.1.tar.gz",
"platform": null,
"description": "[![CI with install](https://github.com/fusion-energy/openmc_cell_segmenter/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/openmc_cell_segmenter/actions/workflows/ci_with_install.yml)\n\n# Segments OpenMC cells into smaller cells.\n\nSpecify the type of segmentation pane desired (XPlane, YPlane, ZPlane or ZCylinder) and the number of segments and obtain segmented cells.\n\n# Install\n\nYou will need to have OpenMC installed then you can use pip to install this package.\n\n```bash\npip install openmc-cell-segmenter\n```\n# Example scripts\n\nExample Python scripts can be found in the [examples folder](https://github.com/fusion-energy/openmc_cell_segmenter/tree/main/example).\n\n# Example outputs\n\nIn this animation we see an S shaped cell that has been segmented first with XPlanes, YPlanes, ZPlanes and ZCylinders colored by cell.\n\n\n![openmc cell segmented zplane](https://user-images.githubusercontent.com/8583900/268407842-6e8783b4-1bc6-443e-ab01-ec390ae3dfe2.gif)\n\n\n# Motivation\n\nCell segmentation has a variety of use cases.\nHowever, this package was originally made for redefining CSG geometry for cell based shutdown dose rate simulations where separate cells are needed to capture the variation in neutron activation across large cells.\n",
"bugtrack_url": null,
"license": "",
"summary": "todo",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/fusion-energy/openmc_cell_segmenter/issues",
"Documentation": "https://openmc_cell_segmenter.readthedocs.io",
"Homepage": "https://github.com/fusion-energy/openmc_cell_segmenter"
},
"split_keywords": [
"python",
"geometry",
"openmc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "340c832eb88b27bc29224658752abae47daf38fd9260742ce86118df70fd6c41",
"md5": "0d9a9754c92926cdb5f80b26409d1b46",
"sha256": "c9957b20329c702e17bc7d6c28dfd9c184d10273a4667dd8de1d0a6628f6c583"
},
"downloads": -1,
"filename": "openmc_cell_segmenter-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0d9a9754c92926cdb5f80b26409d1b46",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4712,
"upload_time": "2023-09-27T15:19:46",
"upload_time_iso_8601": "2023-09-27T15:19:46.327658Z",
"url": "https://files.pythonhosted.org/packages/34/0c/832eb88b27bc29224658752abae47daf38fd9260742ce86118df70fd6c41/openmc_cell_segmenter-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f677746190d68e9fa02d2fc2b8f2f343ead879562c66903fe24d8ee1aa09d852",
"md5": "f96c1e2459bf0f0af04eb87c7b12fdc4",
"sha256": "8f5724152dc21297e80e27a252bb4c990f88ff17ca6d231685c5d4d15475c2f5"
},
"downloads": -1,
"filename": "openmc_cell_segmenter-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "f96c1e2459bf0f0af04eb87c7b12fdc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9020,
"upload_time": "2023-09-27T15:19:47",
"upload_time_iso_8601": "2023-09-27T15:19:47.821038Z",
"url": "https://files.pythonhosted.org/packages/f6/77/746190d68e9fa02d2fc2b8f2f343ead879562c66903fe24d8ee1aa09d852/openmc_cell_segmenter-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 15:19:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fusion-energy",
"github_project": "openmc_cell_segmenter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openmc-cell-segmenter"
}