Metadata-Version: 2.4
Name: paramak
Version: 0.9.10
Summary: Create 3D fusion reactor CAD models based on input parameters
Author: The Paramak Development Team
License: MIT License
        Copyright (c) 2024 Fusion Energy and 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.
Project-URL: Homepage, https://github.com/fusion-energy/paramak
Project-URL: Bug Tracker, https://github.com/fusion-energy/paramak/issues
Project-URL: Documentation, https://fusion-energy.github.io/paramak
Keywords: python,geometry,reactor,model,cad,fusion,parametric,dagmc,openmc
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cadquery>=2.6.0
Requires-Dist: numpy
Requires-Dist: mpmath
Requires-Dist: sympy
Requires-Dist: scipy
Provides-Extra: tests
Requires-Dist: pytest>=5.4.3; extra == "tests"
Requires-Dist: pytest-cov>=2.12.1; extra == "tests"
Requires-Dist: dagmc_h5m_file_inspector>=0.5.0; extra == "tests"
Requires-Dist: openmc_data_downloader; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
Requires-Dist: openmc_data_downloader; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: cadquery; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Requires-Dist: sphinx_design; extra == "docs"
Dynamic: license-file


[![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)

[![CI testing](https://github.com/fusion-energy/paramak/actions/workflows/ci.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/ci.yml)

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

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


# 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 parameter studies and therefore the models are created from parameters.

Paramak produces [CadQuery](https://github.com/CadQuery/CadQuery) objects which can easily be saved to CAD files in several formats (STEP, STL, BRep) and also readily convertable to DAGMC h5m neutronics geometry using tools such as [Cad-to_DAGMC](https://github.com/fusion-energy/cad_to_dagmc).

:point_right: Please see the [online documentation](https://fusion-energy.github.io/paramak) for installation, usage and API documentation.
