(api_reference)=
# API reference

Auto-generated signatures and docstrings for the public phonopy Python
API. For a tutorial-style guide, see {ref}`phonopy_module`.

## Top-level functions

```{eval-rst}
.. autosummary::
   :nosignatures:

   phonopy.load
```

```{eval-rst}
.. autofunction:: phonopy.load
```

## `Phonopy` class

```{eval-rst}
.. autoclass:: phonopy.Phonopy
   :members:
   :show-inheritance:
   :member-order: bysource
```

## `PhonopyAtoms` class

```{eval-rst}
.. autoclass:: phonopy.structure.atoms.PhonopyAtoms
   :members:
   :show-inheritance:
   :member-order: bysource
```

## Calculator interface helpers

```{eval-rst}
.. autosummary::
   :nosignatures:

   phonopy.interface.calculator.read_crystal_structure
   phonopy.interface.calculator.write_crystal_structure
```

```{eval-rst}
.. autofunction:: phonopy.interface.calculator.read_crystal_structure
.. autofunction:: phonopy.interface.calculator.write_crystal_structure
```