openmc-cylindrical-mesh-plotter

Name	openmc-cylindrical-mesh-plotter JSON
Version	0.3.3 JSON
	download
home_page	None
Summary	A Python package for creating plots of OpenMC cylindrical mesh tallies
upload_time	2024-03-20 22:38:46
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	None
keywords	cylindrical mesh openmc tally plot slice
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            [![CI with install](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/actions/workflows/ci_with_install.yml)

# openmc_cylindrical_mesh_plotter

Plots R-Z or Phi-R slices of OpenMC cylindrical mesh tallies


![openmc cylinder PhiR mesh tally plot](https://user-images.githubusercontent.com/8583900/227660135-8ac2eb69-829c-4788-ae02-f9e4b1465aa6.png)
![openmc cylinder RZ mesh tally plot](https://user-images.githubusercontent.com/8583900/227660142-99bcb264-57f8-47d6-b9ff-d211645fe185.png)
![openmc cylinder RZ mesh tally plot with outline](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/assets/8583900/65d222f0-5070-4705-ab99-805e4df49a81)


## Installation

openmc_cylindrical_mesh_plotter is available on PyPi

```bash
pip install openmc_cylindrical_mesh_plotter
```

Install with the optional Graphical User Interface (GUI)

```bash
pip install openmc_cylindrical_mesh_plotter[gui]
```

## API Usage

See the [examples](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/tree/main/examples) folder for example scripts

## Graphical User Interface Usage

Once installed you should be able to type the following command from the terminal and the GUI will launch in a browser window.

```bash
openmc_cylindrical_mesh_plotter
```

![openmc cylinder mesh plot GUI](https://user-images.githubusercontent.com/8583900/228016577-d5d9f541-1b4d-4d9b-a207-f3f1d08e27a8.gif)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "openmc-cylindrical-mesh-plotter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "cylindrical, mesh, openmc, tally, plot, slice",
    "author": null,
    "author_email": "Jonathan Shimwell <mail@jshimwell.com>",
    "download_url": "https://files.pythonhosted.org/packages/1a/eb/80ed4c33c6c1f8ca6150d21b6685993ac22f1c5ea70ce3216e01a51098cb/openmc_cylindrical_mesh_plotter-0.3.3.tar.gz",
    "platform": null,
    "description": "[![CI with install](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/actions/workflows/ci_with_install.yml)\n\n# openmc_cylindrical_mesh_plotter\n\nPlots R-Z or Phi-R slices of OpenMC cylindrical mesh tallies\n\n\n![openmc cylinder PhiR mesh tally plot](https://user-images.githubusercontent.com/8583900/227660135-8ac2eb69-829c-4788-ae02-f9e4b1465aa6.png)\n![openmc cylinder RZ mesh tally plot](https://user-images.githubusercontent.com/8583900/227660142-99bcb264-57f8-47d6-b9ff-d211645fe185.png)\n![openmc cylinder RZ mesh tally plot with outline](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/assets/8583900/65d222f0-5070-4705-ab99-805e4df49a81)\n\n\n## Installation\n\nopenmc_cylindrical_mesh_plotter is available on PyPi\n\n```bash\npip install openmc_cylindrical_mesh_plotter\n```\n\nInstall with the optional Graphical User Interface (GUI)\n\n```bash\npip install openmc_cylindrical_mesh_plotter[gui]\n```\n\n## API Usage\n\nSee the [examples](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/tree/main/examples) folder for example scripts\n\n## Graphical User Interface Usage\n\nOnce installed you should be able to type the following command from the terminal and the GUI will launch in a browser window.\n\n```bash\nopenmc_cylindrical_mesh_plotter\n```\n\n![openmc cylinder mesh plot GUI](https://user-images.githubusercontent.com/8583900/228016577-d5d9f541-1b4d-4d9b-a207-f3f1d08e27a8.gif)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python package for creating plots of OpenMC cylindrical mesh tallies",
    "version": "0.3.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/issues",
        "Homepage": "https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter"
    },
    "split_keywords": [
        "cylindrical",
        " mesh",
        " openmc",
        " tally",
        " plot",
        " slice"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a08fb1087b302e8e77dc14d3635b46dbb9ccbf54c264f223a9c820c80e2a741d",
                "md5": "3fbb1ba7f950ddef3743c6913a5e5436",
                "sha256": "21cb945a2880d24ef9c7f17d28798f0ce3e80b983efc427354dc017ba02f00ac"
            },
            "downloads": -1,
            "filename": "openmc_cylindrical_mesh_plotter-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3fbb1ba7f950ddef3743c6913a5e5436",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 11284,
            "upload_time": "2024-03-20T22:38:44",
            "upload_time_iso_8601": "2024-03-20T22:38:44.462261Z",
            "url": "https://files.pythonhosted.org/packages/a0/8f/b1087b302e8e77dc14d3635b46dbb9ccbf54c264f223a9c820c80e2a741d/openmc_cylindrical_mesh_plotter-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1aeb80ed4c33c6c1f8ca6150d21b6685993ac22f1c5ea70ce3216e01a51098cb",
                "md5": "babe6d57bf3f929a01d220ca1738f6b4",
                "sha256": "7ea7a8f9f680eabf6956b8aad99e43fb962c03925edad4ad8e12b1ae7807c5aa"
            },
            "downloads": -1,
            "filename": "openmc_cylindrical_mesh_plotter-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "babe6d57bf3f929a01d220ca1738f6b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 16790,
            "upload_time": "2024-03-20T22:38:46",
            "upload_time_iso_8601": "2024-03-20T22:38:46.200482Z",
            "url": "https://files.pythonhosted.org/packages/1a/eb/80ed4c33c6c1f8ca6150d21b6685993ac22f1c5ea70ce3216e01a51098cb/openmc_cylindrical_mesh_plotter-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-20 22:38:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fusion-energy",
    "github_project": "openmc_cylindrical_mesh_plotter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "openmc-cylindrical-mesh-plotter"
}