:py:mod:`aiida_lammps.parsers.utils`
====================================

.. py:module:: aiida_lammps.parsers.utils

.. autodoc2-docstring:: aiida_lammps.parsers.utils
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`generate_lammps_structure <aiida_lammps.parsers.utils.generate_lammps_structure>`
     - .. autodoc2-docstring:: aiida_lammps.parsers.utils.generate_lammps_structure
          :summary:
   * - :py:obj:`generate_header <aiida_lammps.parsers.utils.generate_header>`
     - .. autodoc2-docstring:: aiida_lammps.parsers.utils.generate_header
          :summary:
   * - :py:obj:`flatten <aiida_lammps.parsers.utils.flatten>`
     - .. autodoc2-docstring:: aiida_lammps.parsers.utils.flatten
          :summary:
   * - :py:obj:`convert_to_str <aiida_lammps.parsers.utils.convert_to_str>`
     - .. autodoc2-docstring:: aiida_lammps.parsers.utils.convert_to_str
          :summary:
   * - :py:obj:`join_keywords <aiida_lammps.parsers.utils.join_keywords>`
     - .. autodoc2-docstring:: aiida_lammps.parsers.utils.join_keywords
          :summary:

API
~~~

.. py:function:: generate_lammps_structure(structure: aiida.orm.StructureData, atom_style: str = 'atomic', charge_dict: typing.Optional[dict[str, float]] = None, round_dp: typing.Optional[float] = None, docstring: str = 'generated by aiida_lammps') -> typing.Union[str, numpy.array]
   :canonical: aiida_lammps.parsers.utils.generate_lammps_structure

   .. autodoc2-docstring:: aiida_lammps.parsers.utils.generate_lammps_structure

.. py:function:: generate_header(value: str) -> str
   :canonical: aiida_lammps.parsers.utils.generate_header

   .. autodoc2-docstring:: aiida_lammps.parsers.utils.generate_header

.. py:function:: flatten(full_list: list) -> list
   :canonical: aiida_lammps.parsers.utils.flatten

   .. autodoc2-docstring:: aiida_lammps.parsers.utils.flatten

.. py:function:: convert_to_str(value) -> str
   :canonical: aiida_lammps.parsers.utils.convert_to_str

   .. autodoc2-docstring:: aiida_lammps.parsers.utils.convert_to_str

.. py:function:: join_keywords(dct, ignore=None) -> str
   :canonical: aiida_lammps.parsers.utils.join_keywords

   .. autodoc2-docstring:: aiida_lammps.parsers.utils.join_keywords