:py:mod:`aiida_lammps.data.potential`
=====================================

.. py:module:: aiida_lammps.data.potential

.. autodoc2-docstring:: aiida_lammps.data.potential
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`LammpsPotentialData <aiida_lammps.data.potential.LammpsPotentialData>`
     - .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData
          :summary:

API
~~~

.. py:class:: LammpsPotentialData(file: str | pathlib.Path | typing.IO, filename: str | pathlib.Path | None = None, **kwargs: typing.Any)
   :canonical: aiida_lammps.data.potential.LammpsPotentialData

   Bases: :py:obj:`aiida.orm.SinglefileData`

   .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.__init__

   .. py:method:: get_or_create(source: typing.Union[str, pathlib.Path, typing.BinaryIO], filename: typing.Optional[str] = None, pair_style: typing.Optional[str] = None, species: typing.Optional[list] = None, atom_style: typing.Optional[str] = None, units: typing.Optional[str] = None, extra_tags: typing.Optional[dict] = None)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.get_or_create
      :classmethod:

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.get_or_create

   .. py:method:: get_entry_point_name() -> str
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.get_entry_point_name
      :classmethod:

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.get_entry_point_name

   .. py:method:: is_readable_byte_stream(stream) -> bool
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.is_readable_byte_stream
      :staticmethod:

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.is_readable_byte_stream

   .. py:method:: prepare_source(source: typing.Union[str, pathlib.Path, typing.BinaryIO]) -> typing.BinaryIO
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.prepare_source
      :classmethod:

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.prepare_source

   .. py:method:: validate_md5(md5: str)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.validate_md5

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.validate_md5

   .. py:method:: validate_pair_style(pair_style: str)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.validate_pair_style

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.validate_pair_style

   .. py:method:: validate_species(species: list)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.validate_species

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.validate_species

   .. py:method:: validate_atom_style(atom_style: str, pair_style: str)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.validate_atom_style

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.validate_atom_style

   .. py:method:: validate_element(element: str)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.validate_element
      :classmethod:

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.validate_element

   .. py:method:: validate_units(units: str, pair_style: str)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.validate_units

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.validate_units

   .. py:method:: validate_extra_tags(extra_tags: dict)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.validate_extra_tags

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.validate_extra_tags

   .. py:method:: set_file(source: typing.Union[str, pathlib.Path, typing.BinaryIO], filename: typing.Optional[str] = None, pair_style: typing.Optional[str] = None, species: typing.Optional[list] = None, atom_style: typing.Optional[str] = None, units: typing.Optional[str] = None, extra_tags: typing.Optional[dict] = None, **kwargs)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.set_file

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.set_file

   .. py:method:: store(**kwargs)
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.store

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.store

   .. py:property:: atom_style
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.atom_style
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.atom_style

   .. py:property:: pair_style
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.pair_style
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.pair_style

   .. py:property:: species
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.species
      :type: list[str]

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.species

   .. py:property:: default_units
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.default_units
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.default_units

   .. py:property:: content_origin
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.content_origin
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.content_origin

   .. py:property:: content_other_locations
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.content_other_locations
      :type: typing.Union[str, list[str]]

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.content_other_locations

   .. py:property:: data_method
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.data_method
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.data_method

   .. py:property:: description
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.description
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.description

   .. py:property:: developer
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.developer
      :type: typing.Union[str, list[str]]

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.developer

   .. py:property:: disclaimer
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.disclaimer
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.disclaimer

   .. py:property:: properties
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.properties
      :type: typing.Union[str, list[str]]

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.properties

   .. py:property:: publication_year
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.publication_year
      :type: typing.Union[str, datetime.datetime, int]

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.publication_year

   .. py:property:: source_citations
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.source_citations
      :type: typing.Union[str, list[str]]

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.source_citations

   .. py:property:: title
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.title
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.title

   .. py:property:: md5
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.md5
      :type: typing.Optional[int]

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.md5

   .. py:property:: generation_method
      :canonical: aiida_lammps.data.potential.LammpsPotentialData.generation_method
      :type: str

      .. autodoc2-docstring:: aiida_lammps.data.potential.LammpsPotentialData.generation_method