httk.atomistic.models.protopattern.label_string
===============================================

.. py:module:: httk.atomistic.models.protopattern.label_string

.. autoapi-nested-parse::

   Backend wrapping a raw canonical protopattern label string.



Classes
-------

.. autoapisummary::

   httk.atomistic.models.protopattern.label_string.ProtopatternLabelString


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

.. py:class:: ProtopatternLabelString(obj, **hints)

   Bases: :py:obj:`httk.atomistic.models.protopattern.backend.ProtopatternBackend`


   Wrap a canonical protopattern label held as a plain string.

   The string must be a canonical unsuffixed protopattern label (no ``:`` species
   suffix); anything else is declined. Parsing is eager, so the wrapped value is
   validated at adoption.

   :param obj: The canonical protopattern label text.
   :param \*\*hints: Backend-selection hints.


   .. py:attribute:: kind
      :value: 'protopattern'



   .. py:property:: spacegroup

      Return the standard-setting space group of the parsed label.


   .. py:property:: occupations

      Return the class-partitioned occupations of the parsed label.


   .. py:method:: unwrap()

      Return the original label text.