| Name | openmc-regular-mesh-plotter JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | |
| Summary | A Python package for creating plots of OpenMC regular mesh tallies with the underlying geometry |
| upload_time | 2024-02-29 22:35:52 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2021 Fusion Energy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
regular
mesh
openmc
tally
plot
slice
geometry
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://www.python.org)
[](https://github.com/fusion-energy/openmc_regular_mesh_plotter/actions/workflows/ci_with_install.yml)
[](https://pypi.org/project/openmc-regular-mesh-plotter/)
# A minimal Python package that plots slices of OpenMC regular mesh tallies with the model geometry.
Features
:straight_ruler: Axis units in in helpful units mm, cm, m, km
:eyes: Supports all 3 viewing basis (xy, xz, yz)
:hocho: Automaticly finds central slice or allows user specified slice index
:dart: Supports all values (mean, std_dev etc)
:black_square_button: Adds outlines for geometry cells or material at different pixel resolution
:arrow_right_hook: Customisable by passing keywords to underlying matplotlib functions colorbar, contour and imshow
:arrow_right_hook: supports further customisations throught ```matplotlib.rc()```
:heavy_plus_sign: Add tally results together to get combined plot.
|<img src="https://user-images.githubusercontent.com/8583900/265032335-27463ee9-8960-4f5e-a662-dab0b6cd9fc5.png" alt="drawing" width="400"/>|<img src="https://user-images.githubusercontent.com/8583900/265065370-734c66ab-b20e-40c8-b72b-88203ea4347b.gif" alt="drawing" width="400"/>|
# Local install
First you will need openmc installed, then you can install this package with pip
```bash
pip install openmc_regular_mesh_plotter
```
# Usage
See the [examples folder](https://github.com/fusion-energy/openmc_regular_mesh_plotter/tree/main/examples) for example scripts
# Web App
This package is deployed on [xsplot.com](https://www.xsplot.com) as part of the ```openmc_plot``` suite of plotting apps
Raw data
{
"_id": null,
"home_page": "",
"name": "openmc-regular-mesh-plotter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "regular,mesh,openmc,tally,plot,slice,geometry",
"author": "",
"author_email": "Jonathan Shimwell <mail@jshimwell.com>",
"download_url": "https://files.pythonhosted.org/packages/79/a2/39865d5ef8e368c31c3da2d0c8129e2af02b702396861bab28aacd385346/openmc_regular_mesh_plotter-1.2.1.tar.gz",
"platform": null,
"description": "[](https://www.python.org)\n\n[](https://github.com/fusion-energy/openmc_regular_mesh_plotter/actions/workflows/ci_with_install.yml)\n\n[](https://pypi.org/project/openmc-regular-mesh-plotter/)\n\n\n# A minimal Python package that plots slices of OpenMC regular mesh tallies with the model geometry.\n\nFeatures\n\n:straight_ruler: Axis units in in helpful units mm, cm, m, km\n\n:eyes: Supports all 3 viewing basis (xy, xz, yz)\n\n:hocho: Automaticly finds central slice or allows user specified slice index\n\n:dart: Supports all values (mean, std_dev etc)\n\n:black_square_button: Adds outlines for geometry cells or material at different pixel resolution\n\n:arrow_right_hook: Customisable by passing keywords to underlying matplotlib functions colorbar, contour and imshow\n\n:arrow_right_hook: supports further customisations throught ```matplotlib.rc()```\n\n:heavy_plus_sign: Add tally results together to get combined plot.\n\n|<img src=\"https://user-images.githubusercontent.com/8583900/265032335-27463ee9-8960-4f5e-a662-dab0b6cd9fc5.png\" alt=\"drawing\" width=\"400\"/>|<img src=\"https://user-images.githubusercontent.com/8583900/265065370-734c66ab-b20e-40c8-b72b-88203ea4347b.gif\" alt=\"drawing\" width=\"400\"/>|\n\n# Local install\n\nFirst you will need openmc installed, then you can install this package with pip\n\n```bash\npip install openmc_regular_mesh_plotter\n```\n\n# Usage\n\nSee the [examples folder](https://github.com/fusion-energy/openmc_regular_mesh_plotter/tree/main/examples) for example scripts\n\n# Web App\n\nThis package is deployed on [xsplot.com](https://www.xsplot.com) as part of the ```openmc_plot``` suite of plotting apps\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Fusion Energy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Python package for creating plots of OpenMC regular mesh tallies with the underlying geometry",
"version": "1.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/fusion-energy/openmc_regular_mesh_plotter/issues",
"Homepage": "https://github.com/fusion-energy/openmc_regular_mesh_plotter"
},
"split_keywords": [
"regular",
"mesh",
"openmc",
"tally",
"plot",
"slice",
"geometry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6aa18dca5225ef1c8135901bbecbd09189d9da7f6974b96dafd66fa2b668c226",
"md5": "3afa92b457328610543a6b05f72eaad9",
"sha256": "a172cd8e1504ab2e439d9b4088cfb0fd1a72fe301864565f1ee7b3ddcfdb1b21"
},
"downloads": -1,
"filename": "openmc_regular_mesh_plotter-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3afa92b457328610543a6b05f72eaad9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9146,
"upload_time": "2024-02-29T22:35:51",
"upload_time_iso_8601": "2024-02-29T22:35:51.019651Z",
"url": "https://files.pythonhosted.org/packages/6a/a1/8dca5225ef1c8135901bbecbd09189d9da7f6974b96dafd66fa2b668c226/openmc_regular_mesh_plotter-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "79a239865d5ef8e368c31c3da2d0c8129e2af02b702396861bab28aacd385346",
"md5": "398eef165be2f55baa5adc7264c9045f",
"sha256": "f022b59ef217b459756d221eed11e325fdb5cadeb60539d64a3704747564ec81"
},
"downloads": -1,
"filename": "openmc_regular_mesh_plotter-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "398eef165be2f55baa5adc7264c9045f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17957,
"upload_time": "2024-02-29T22:35:52",
"upload_time_iso_8601": "2024-02-29T22:35:52.435563Z",
"url": "https://files.pythonhosted.org/packages/79/a2/39865d5ef8e368c31c3da2d0c8129e2af02b702396861bab28aacd385346/openmc_regular_mesh_plotter-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 22:35:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fusion-energy",
"github_project": "openmc_regular_mesh_plotter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openmc-regular-mesh-plotter"
}
