picometer.models
================

.. py:module:: picometer.models


Attributes
----------

.. autoapisummary::

   picometer.models.logger


Classes
-------

.. autoapisummary::

   picometer.models.ModelState
   picometer.models.ModelStates


Module Contents
---------------

.. py:data:: logger

.. py:class:: ModelState(atoms: picometer.atom.AtomSet, centroids: picometer.atom.AtomSet = AtomSet(), shapes: dict[str, picometer.shapes.ExplicitShape] = None)

   Class describing atomsets, selections, and shapes in one structure


   .. py:attribute:: atoms
      :type:  picometer.atom.AtomSet


   .. py:attribute:: centroids
      :type:  picometer.atom.AtomSet


   .. py:attribute:: shapes
      :type:  dict[str, picometer.shapes.ExplicitShape]


   .. py:property:: nodes
      :type: picometer.atom.AtomSet



.. py:class:: ModelStates

   Bases: :py:obj:`dict`\ [\ :py:obj:`str`\ , :py:obj:`ModelState`\ ]


   A simple dictionary that stores `ModelState`s under their path