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

.. py:module:: aiida_vasp.common.transform

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`magnetic_structure_decorate <aiida_vasp.common.transform.magnetic_structure_decorate>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.magnetic_structure_decorate
          :summary:
   * - :py:obj:`magnetic_structure_dedecorate <aiida_vasp.common.transform.magnetic_structure_dedecorate>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.magnetic_structure_dedecorate
          :summary:
   * - :py:obj:`rattle <aiida_vasp.common.transform.rattle>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.rattle
          :summary:
   * - :py:obj:`random_rattle <aiida_vasp.common.transform.random_rattle>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.random_rattle
          :summary:
   * - :py:obj:`get_primitive <aiida_vasp.common.transform.get_primitive>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.get_primitive
          :summary:
   * - :py:obj:`get_standard_primitive <aiida_vasp.common.transform.get_standard_primitive>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.get_standard_primitive
          :summary:
   * - :py:obj:`spglib_refine_cell <aiida_vasp.common.transform.spglib_refine_cell>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.spglib_refine_cell
          :summary:
   * - :py:obj:`get_standard_conventional <aiida_vasp.common.transform.get_standard_conventional>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.get_standard_conventional
          :summary:
   * - :py:obj:`get_refined_structure <aiida_vasp.common.transform.get_refined_structure>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.get_refined_structure
          :summary:
   * - :py:obj:`get_conventional_standard_structure <aiida_vasp.common.transform.get_conventional_standard_structure>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.get_conventional_standard_structure
          :summary:
   * - :py:obj:`make_supercell <aiida_vasp.common.transform.make_supercell>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.make_supercell
          :summary:
   * - :py:obj:`niggli_reduce <aiida_vasp.common.transform.niggli_reduce>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.niggli_reduce
          :summary:
   * - :py:obj:`niggli_reduce_spglib <aiida_vasp.common.transform.niggli_reduce_spglib>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.niggli_reduce_spglib
          :summary:
   * - :py:obj:`neb_interpolate <aiida_vasp.common.transform.neb_interpolate>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.neb_interpolate
          :summary:
   * - :py:obj:`fix_atom_order <aiida_vasp.common.transform.fix_atom_order>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.fix_atom_order
          :summary:
   * - :py:obj:`match_atomic_order_ <aiida_vasp.common.transform.match_atomic_order_>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.match_atomic_order_
          :summary:
   * - :py:obj:`create_additional_species <aiida_vasp.common.transform.create_additional_species>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.create_additional_species
          :summary:
   * - :py:obj:`convert_to_plain_list <aiida_vasp.common.transform.convert_to_plain_list>`
     - .. autodoc2-docstring:: aiida_vasp.common.transform.convert_to_plain_list
          :summary:

API
~~~

.. py:function:: magnetic_structure_decorate(structure: aiida.orm.StructureData, magmom: aiida.orm.List) -> dict[str, typing.Any]
   :canonical: aiida_vasp.common.transform.magnetic_structure_decorate

   .. autodoc2-docstring:: aiida_vasp.common.transform.magnetic_structure_decorate

.. py:function:: magnetic_structure_dedecorate(structure: aiida.orm.StructureData, mapping: aiida.orm.Dict) -> dict[str, typing.Any]
   :canonical: aiida_vasp.common.transform.magnetic_structure_dedecorate

   .. autodoc2-docstring:: aiida_vasp.common.transform.magnetic_structure_dedecorate

.. py:function:: rattle(structure: aiida.orm.StructureData, amp: aiida.orm.Float) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.rattle

   .. autodoc2-docstring:: aiida_vasp.common.transform.rattle

.. py:function:: random_rattle(structure: aiida.orm.StructureData, amp: aiida.orm.Float) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.random_rattle

   .. autodoc2-docstring:: aiida_vasp.common.transform.random_rattle

.. py:function:: get_primitive(structure: aiida.orm.StructureData) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.get_primitive

   .. autodoc2-docstring:: aiida_vasp.common.transform.get_primitive

.. py:function:: get_standard_primitive(structure: aiida.orm.StructureData, **kwargs: typing.Any) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.get_standard_primitive

   .. autodoc2-docstring:: aiida_vasp.common.transform.get_standard_primitive

.. py:function:: spglib_refine_cell(structure: aiida.orm.StructureData, symprec: typing.Any) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.spglib_refine_cell

   .. autodoc2-docstring:: aiida_vasp.common.transform.spglib_refine_cell

.. py:function:: get_standard_conventional(structure: aiida.orm.StructureData) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.get_standard_conventional

   .. autodoc2-docstring:: aiida_vasp.common.transform.get_standard_conventional

.. py:function:: get_refined_structure(structure: aiida.orm.StructureData, symprec: aiida.orm.Float, angle_tolerance: typing.Any) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.get_refined_structure

   .. autodoc2-docstring:: aiida_vasp.common.transform.get_refined_structure

.. py:function:: get_conventional_standard_structure(structure: aiida.orm.StructureData, symprec: aiida.orm.Float, angle_tolerance: typing.Any) -> typing.Any
   :canonical: aiida_vasp.common.transform.get_conventional_standard_structure

   .. autodoc2-docstring:: aiida_vasp.common.transform.get_conventional_standard_structure

.. py:function:: make_supercell(structure: typing.Any, supercell: typing.Any, **kwargs: typing.Any) -> dict[str, typing.Any]
   :canonical: aiida_vasp.common.transform.make_supercell

   .. autodoc2-docstring:: aiida_vasp.common.transform.make_supercell

.. py:function:: niggli_reduce(structure: aiida.orm.StructureData) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.niggli_reduce

   .. autodoc2-docstring:: aiida_vasp.common.transform.niggli_reduce

.. py:function:: niggli_reduce_spglib(structure: aiida.orm.StructureData) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.niggli_reduce_spglib

   .. autodoc2-docstring:: aiida_vasp.common.transform.niggli_reduce_spglib

.. py:function:: neb_interpolate(init_structure: aiida.orm.StructureData, final_strucrture: aiida.orm.StructureData, nimages: aiida.orm.Int) -> dict[str, aiida.orm.StructureData]
   :canonical: aiida_vasp.common.transform.neb_interpolate

   .. autodoc2-docstring:: aiida_vasp.common.transform.neb_interpolate

.. py:function:: fix_atom_order(reference: aiida.orm.StructureData, to_fix: aiida.orm.StructureData) -> aiida.orm.StructureData
   :canonical: aiida_vasp.common.transform.fix_atom_order

   .. autodoc2-docstring:: aiida_vasp.common.transform.fix_atom_order

.. py:function:: match_atomic_order_(atoms: ase.Atoms, atoms_ref: ase.Atoms) -> typing.Tuple[ase.Atoms, typing.List[int]]
   :canonical: aiida_vasp.common.transform.match_atomic_order_

   .. autodoc2-docstring:: aiida_vasp.common.transform.match_atomic_order_

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

   .. autodoc2-docstring:: aiida_vasp.common.transform.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.transform.convert_to_plain_list

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