| Name | openmc-plot JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | A Python package containing a collection of scripts for producing and downloading data for OpenMC |
| upload_time | 2023-05-18 13:24:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2022 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 |
openmc
plot
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
A Python app for plotting OpenMC.
This repository contains the source code for the OpenMC plot.
Try the web app at [http://openmc-plot.xsplot.com](http://openmc-plot.xsplot.com)
This repository contains:
- A Python [Streamlit](https://streamlit.io) based GUI 🐍
- A Dockerfile that provides the hosting environment for the web app 🐳
# Plot geometry
# Plot sources
# Plot regular mesh tallies
# Plot weight windows
# Plot cylindrical mesh tallies
# Install
First you will need to [install OpenMC](https://docs.openmc.org/en/stable/quickinstall.html)
OpenMC_plot can then be install directly from the Python package index (PyPi) using pip.
```
pip install openmc_plot
```
# Usage
In the terminal type ...
```
openmc_plot
```
Your default web browser should then load with the GUI.
You will also need to have [OpenMC installed](https://docs.openmc.org/en/stable/quickinstall.html).
# Run web app locally (developers)
To host your own local version of [xsplot.com](http://xsplot.com) you will need [Docker](https://www.docker.com/) installed and then can build and run the Dockerfile
with the following commands.
First clone the repository
```bash
git clone https://github.com/fusion-energy/openmc_plot
```
Then navigate into the repository folder
```bash
cd openmc_plot
```
Then build the docker image
```bash
docker build -t openmc_plot .
```
Then run the docker image
```bash
docker run --network host -t openmc_plot
```
The URL of your locally hosted version should appear in the terminal, copy and paste this URL into a web browser address bar.
# Maintenance (developers)
Pushing to the main branch of this repository triggers an automatic rebuild and
deployment of the new code using Google Cloud build at [xsplot.com](http://xsplot.com)
Raw data
{
"_id": null,
"home_page": "",
"name": "openmc-plot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "openmc,plot",
"author": "",
"author_email": "Jonathan Shimwell <mail@jshimwell.com>",
"download_url": "https://files.pythonhosted.org/packages/46/fb/d158a0e6b93d2b5e47f7e0b6f65b7ae0c329e53202c34542614d676e64eb/openmc_plot-0.3.1.tar.gz",
"platform": null,
"description": "A Python app for plotting OpenMC.\n\nThis repository contains the source code for the OpenMC plot.\n\nTry the web app at [http://openmc-plot.xsplot.com](http://openmc-plot.xsplot.com)\n\nThis repository contains:\n- A Python [Streamlit](https://streamlit.io) based GUI \ud83d\udc0d\n- A Dockerfile that provides the hosting environment for the web app \ud83d\udc33\n\n# Plot geometry\n\n\n# Plot sources\n\n\n# Plot regular mesh tallies\n\n\n# Plot weight windows\n\n\n# Plot cylindrical mesh tallies\n\n\n# Install\n\nFirst you will need to [install OpenMC](https://docs.openmc.org/en/stable/quickinstall.html)\n\nOpenMC_plot can then be install directly from the Python package index (PyPi) using pip.\n\n```\npip install openmc_plot\n```\n\n# Usage\n\nIn the terminal type ...\n\n```\nopenmc_plot\n```\n\nYour default web browser should then load with the GUI.\n\nYou will also need to have [OpenMC installed](https://docs.openmc.org/en/stable/quickinstall.html).\n\n# Run web app locally (developers)\n\nTo host your own local version of [xsplot.com](http://xsplot.com) you will need [Docker](https://www.docker.com/) installed and then can build and run the Dockerfile\nwith the following commands.\n\nFirst clone the repository\n```bash\ngit clone https://github.com/fusion-energy/openmc_plot\n```\n\nThen navigate into the repository folder\n```bash\ncd openmc_plot\n```\n\nThen build the docker image\n```bash\ndocker build -t openmc_plot .\n```\n\nThen run the docker image\n```bash\ndocker run --network host -t openmc_plot\n```\n\nThe URL of your locally hosted version should appear in the terminal, copy and paste this URL into a web browser address bar.\n\n# Maintenance (developers)\n\nPushing to the main branch of this repository triggers an automatic rebuild and\ndeployment of the new code using Google Cloud build at [xsplot.com](http://xsplot.com)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 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 containing a collection of scripts for producing and downloading data for OpenMC",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/fusion-energy/openmc_plot/issues",
"Homepage": "https://github.com/fusion-energy/openmc_plot"
},
"split_keywords": [
"openmc",
"plot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be27e53b6a141389aa6c4c3f514eb7f08a39fc8d97358a0feb95076c57f9a7e8",
"md5": "1c77197546455b1446f47cebf7e61410",
"sha256": "591226ff5d2b8dd57706220f6da9985a6f641294471a109feb1b1ae8f8c54911"
},
"downloads": -1,
"filename": "openmc_plot-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c77197546455b1446f47cebf7e61410",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1052651,
"upload_time": "2023-05-18T13:24:09",
"upload_time_iso_8601": "2023-05-18T13:24:09.515580Z",
"url": "https://files.pythonhosted.org/packages/be/27/e53b6a141389aa6c4c3f514eb7f08a39fc8d97358a0feb95076c57f9a7e8/openmc_plot-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46fbd158a0e6b93d2b5e47f7e0b6f65b7ae0c329e53202c34542614d676e64eb",
"md5": "4937cf902aeba44c397f18f0b854cae8",
"sha256": "068662db15df98e694db861efe6cd55d709dd72d03078dc0306f48a312a497a4"
},
"downloads": -1,
"filename": "openmc_plot-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "4937cf902aeba44c397f18f0b854cae8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1161548,
"upload_time": "2023-05-18T13:24:11",
"upload_time_iso_8601": "2023-05-18T13:24:11.927575Z",
"url": "https://files.pythonhosted.org/packages/46/fb/d158a0e6b93d2b5e47f7e0b6f65b7ae0c329e53202c34542614d676e64eb/openmc_plot-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-18 13:24:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fusion-energy",
"github_project": "openmc_plot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openmc-plot"
}
