
Paramak documentation
=====================



**Version**: |version|


.. toctree::
   :maxdepth: 3
   :caption: Contents:
   :hidden:

   install
   examples
   python_api

Parameter driven CAD creation for fusion reactors.

Paramak provides parameter driven creation of Tokamak and Spherical Tokamak CAD models as well as DAGMC compatible neutronics models.

The style of reaction, sizes of components, plasma shape and number of radial or vertical layers can be specified,  

.. raw:: html

    <div style="display: flex; justify-content: center;">
        <video width="45%" controls autoplay loop>
            <source src="_static/spherical_tokamak_animation.mp4" type="video/mp4">
            Your browser does not support the video tag.
        </video>
        <video width="45%" controls autoplay loop>
            <source src="_static/tokamak_animation.mp4" type="video/mp4">
            Your browser does not support the video tag.
        </video>
    </div>

.. video:: _static/tokamak_animation.mp4
   :alt: Spherical Tokamak Animation
   :align: center
   :autoplay: true
   :loop: true

.. grid:: 1 1 3 3
    :gutter: 2

    .. grid-item-card::
        :img-top: _static/getting_started.svg
        :text-align: center

        Installation
        ^^^

        .. button-ref:: install
            :expand:
            :color: secondary
            :click-parent:

            To the installation guide

    .. grid-item-card::
        :img-top: _static/user_guide.svg
        :text-align: center

        Examples
        ^^^

        .. button-ref:: examples
            :expand:
            :color: secondary
            :click-parent:

            To the examples

    .. grid-item-card::
        :img-top: _static/api.svg
        :text-align: center

        API reference
        ^^^

        .. button-ref:: python_api
            :expand:
            :color: secondary
            :click-parent:

            To the reference guide

