paramak


Nameparamak JSON
Version 0.8.7 PyPI version JSON
download
home_page
SummaryCreate 3D fusion reactor CAD models based on input parameters
upload_time2023-01-01 21:07:46
maintainer
docs_urlNone
authorThe Paramak Development Team
requires_python>=3.8
licenseMIT License Copyright (c) 2020 UKAEA Copyright (c) 2021 Paramak contributors 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 python geometry reactor model cad fusion parametric dagmc openmc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
[![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)

[![CircleCI](https://circleci.com/gh/fusion-energy/paramak/tree/main.svg?style=svg)](https://circleci.com/gh/fusion-energy/paramak/tree/main)
[![CI with docker build](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_docker_build.yml/badge.svg?branch=main)](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_docker_build.yml)
[![CI with install](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_install.yml/badge.svg?branch=main)](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_install.yml)

[![codecov](https://codecov.io/gh/fusion-energy/paramak/branch/main/graph/badge.svg)](https://codecov.io/gh/fusion-energy/paramak)

[![Code Grade](https://api.codiga.io/project/25342/score/svg)](https://app.codiga.io/public/project/25342/paramak/dashboard)
[![Code Grade](https://api.codiga.io/project/25342/status/svg)](https://app.codiga.io/public/project/25342/paramak/dashboard)


[![Documentation Status](https://readthedocs.org/projects/paramak/badge/?version=main)](https://paramak.readthedocs.io/en/main/?badge=main)


[![Upload Python Package](https://github.com/fusion-energy/paramak/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/python-publish.yml)
[![PyPI](https://img.shields.io/pypi/v/paramak?color=brightgreen&label=pypi&logo=grebrightgreenen&logoColor=green)](https://pypi.org/project/paramak/)

[![anaconda-publish](https://github.com/fusion-energy/paramak/actions/workflows/anaconda-publish.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/anaconda-publish.yml)
[![anaconda.org](https://anaconda.org/fusion-energy/paramak/badges/version.svg)](https://anaconda.org/fusion-energy/paramak)

[![docker-publish-release](https://github.com/fusion-energy/paramak/actions/workflows/docker_publish.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/docker_publish.yml)

[![DOI](https://zenodo.org/badge/269635577.svg)](https://zenodo.org/badge/latestdoi/269635577)

# Paramak

Paramak python package allows rapid production of 3D CAD models and neutronics
models of fusion reactors. The purpose of Paramak is to provide geometry for
parametric studies. Paramak can create geometry in standard CAD formats such as
STP, STL, BRep, HTML and DAGMC h5m.

:point_right: [Documentation](https://paramak.readthedocs.io)

:point_right: [Video presentation](https://www.youtube.com/embed/fXboew3U7rw)

:point_right: [Installation](https://paramak.readthedocs.io/en/main/install.html)

:point_right: [Publication](https://f1000research.com/articles/10-27)

:point_right: [Docker images](https://github.com/fusion-energy/paramak/pkgs/container/paramak)

:point_right: Examples with Neutronics [1](https://github.com/fusion-energy/magnetic_fusion_openmc_dagmc_paramak_example), [2](https://github.com/fusion-energy/inertial_fusion_openmc_dagmc_paramak_example), [3](https://github.com/fusion-energy/neutronics-workshop)

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "paramak",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "python,geometry,reactor,model,cad,fusion,parametric,dagmc,openmc",
    "author": "The Paramak Development Team",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/19/75/cab0465656b53425c96790ae67fcb1fab57493814315f1488ac3421b98bd/paramak-0.8.7.tar.gz",
    "platform": null,
    "description": "\n[![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)\n\n[![CircleCI](https://circleci.com/gh/fusion-energy/paramak/tree/main.svg?style=svg)](https://circleci.com/gh/fusion-energy/paramak/tree/main)\n[![CI with docker build](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_docker_build.yml/badge.svg?branch=main)](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_docker_build.yml)\n[![CI with install](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_install.yml/badge.svg?branch=main)](https://github.com/fusion-energy/paramak/actions/workflows/ci_with_install.yml)\n\n[![codecov](https://codecov.io/gh/fusion-energy/paramak/branch/main/graph/badge.svg)](https://codecov.io/gh/fusion-energy/paramak)\n\n[![Code Grade](https://api.codiga.io/project/25342/score/svg)](https://app.codiga.io/public/project/25342/paramak/dashboard)\n[![Code Grade](https://api.codiga.io/project/25342/status/svg)](https://app.codiga.io/public/project/25342/paramak/dashboard)\n\n\n[![Documentation Status](https://readthedocs.org/projects/paramak/badge/?version=main)](https://paramak.readthedocs.io/en/main/?badge=main)\n\n\n[![Upload Python Package](https://github.com/fusion-energy/paramak/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/python-publish.yml)\n[![PyPI](https://img.shields.io/pypi/v/paramak?color=brightgreen&label=pypi&logo=grebrightgreenen&logoColor=green)](https://pypi.org/project/paramak/)\n\n[![anaconda-publish](https://github.com/fusion-energy/paramak/actions/workflows/anaconda-publish.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/anaconda-publish.yml)\n[![anaconda.org](https://anaconda.org/fusion-energy/paramak/badges/version.svg)](https://anaconda.org/fusion-energy/paramak)\n\n[![docker-publish-release](https://github.com/fusion-energy/paramak/actions/workflows/docker_publish.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/docker_publish.yml)\n\n[![DOI](https://zenodo.org/badge/269635577.svg)](https://zenodo.org/badge/latestdoi/269635577)\n\n# Paramak\n\nParamak python package allows rapid production of 3D CAD models and neutronics\nmodels of fusion reactors. The purpose of Paramak is to provide geometry for\nparametric studies. Paramak can create geometry in standard CAD formats such as\nSTP, STL, BRep, HTML and DAGMC h5m.\n\n:point_right: [Documentation](https://paramak.readthedocs.io)\n\n:point_right: [Video presentation](https://www.youtube.com/embed/fXboew3U7rw)\n\n:point_right: [Installation](https://paramak.readthedocs.io/en/main/install.html)\n\n:point_right: [Publication](https://f1000research.com/articles/10-27)\n\n:point_right: [Docker images](https://github.com/fusion-energy/paramak/pkgs/container/paramak)\n\n:point_right: Examples with Neutronics [1](https://github.com/fusion-energy/magnetic_fusion_openmc_dagmc_paramak_example), [2](https://github.com/fusion-energy/inertial_fusion_openmc_dagmc_paramak_example), [3](https://github.com/fusion-energy/neutronics-workshop)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2020 UKAEA Copyright (c) 2021 Paramak contributors  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": "Create 3D fusion reactor CAD models based on input parameters",
    "version": "0.8.7",
    "split_keywords": [
        "python",
        "geometry",
        "reactor",
        "model",
        "cad",
        "fusion",
        "parametric",
        "dagmc",
        "openmc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e1d8dd5fa1b10f5734a21e9bd527de20",
                "sha256": "0282c96a53f478aeff2eff985dd1fe12d2aeee7a53c98ecd33496178834fc300"
            },
            "downloads": -1,
            "filename": "paramak-0.8.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e1d8dd5fa1b10f5734a21e9bd527de20",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 153902,
            "upload_time": "2023-01-01T21:07:45",
            "upload_time_iso_8601": "2023-01-01T21:07:45.291588Z",
            "url": "https://files.pythonhosted.org/packages/49/cd/e846e6142e979caa34359ade097249de0d44e8b1dd614ab230918dccd896/paramak-0.8.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "0867a0dc6f637ea283c5ff021e16c042",
                "sha256": "347fc6268d53465ae7393d6f554313a551e0d254931fc30ebc453c5081ba965f"
            },
            "downloads": -1,
            "filename": "paramak-0.8.7.tar.gz",
            "has_sig": false,
            "md5_digest": "0867a0dc6f637ea283c5ff021e16c042",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 207286,
            "upload_time": "2023-01-01T21:07:46",
            "upload_time_iso_8601": "2023-01-01T21:07:46.774678Z",
            "url": "https://files.pythonhosted.org/packages/19/75/cab0465656b53425c96790ae67fcb1fab57493814315f1488ac3421b98bd/paramak-0.8.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-01 21:07:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "paramak"
}
The Paramak Development Team
Elapsed time: 0.02277s