:py:mod:`aiida_vasp.common.magmapping`
======================================

.. py:module:: aiida_vasp.common.magmapping

.. autodoc2-docstring:: aiida_vasp.common.magmapping
   :allowtitles:

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

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`create_additional_species <aiida_vasp.common.magmapping.create_additional_species>`
     - .. autodoc2-docstring:: aiida_vasp.common.magmapping.create_additional_species
          :summary:
   * - :py:obj:`convert_to_plain_list <aiida_vasp.common.magmapping.convert_to_plain_list>`
     - .. autodoc2-docstring:: aiida_vasp.common.magmapping.convert_to_plain_list
          :summary:

API
~~~

.. py:function:: create_additional_species(species: list[str], magmom: list[float]) -> tuple[list[str], dict[str, float]]
   :canonical: aiida_vasp.common.magmapping.create_additional_species

   .. autodoc2-docstring:: aiida_vasp.common.magmapping.create_additional_species

.. py:function:: convert_to_plain_list(species: list[str], magmom_mapping: dict[str, float]) -> tuple[list[str], list[float]]
   :canonical: aiida_vasp.common.magmapping.convert_to_plain_list

   .. autodoc2-docstring:: aiida_vasp.common.magmapping.convert_to_plain_list