:orphan:

API reference
=============

.. currentmodule:: porems


.. _generation_api:

Molecule
--------

.. autosummary::
    :toctree: generated/

    molecule.Molecule
    atom.Atom
    store.Store


.. _pore_api:

Pore
----

.. autosummary::
    :toctree: generated/

    pore.Pore
    system.PoreKit
    system.PoreCylinder
    system.PoreSlit
    system.PoreCapsule
    system.PoreAmorphCylinder


.. _pattern_api:

Pattern
~~~~~~~

.. autosummary::
    :toctree: generated/

    pattern.Pattern
    pattern.AlphaCristobalit
    pattern.BetaCristobalit


.. _shape_api:

Shape
~~~~~

.. autosummary::
    :toctree: generated/

    shape.Shape
    shape.Cylinder
    shape.Sphere
    shape.Cuboid
    shape.Cone


.. _optimization_api:

Optimization
~~~~~~~~~~~~

.. autosummary::
    :toctree: generated/

    dice.Dice
    matrix.Matrix


.. _utils_api:

Utilities
---------

.. autosummary::
    :toctree: generated/

    utils
    generic
    geometry
    database