phonopy/README.md

24 lines
1.1 KiB
Markdown

[![Version Badge](https://anaconda.org/conda-forge/phonopy/badges/version.svg)](https://anaconda.org/conda-forge/phonopy)
[![Downloads Badge](https://anaconda.org/conda-forge/phonopy/badges/downloads.svg)](https://anaconda.org/conda-forge/phonopy)
[![PyPI](https://img.shields.io/pypi/dm/phonopy.svg?maxAge=2592000)](https://pypi.python.org/pypi/phonopy)
[![Build Status](https://travis-ci.org/atztogo/phonopy.svg?branch=master)](https://travis-ci.org/atztogo/phonopy)
# Phonopy
Phonon code. Phonopy user documetation is found at http://phonopy.github.io/phonopy/
## Mailing list for questions
Usual phonopy questions should be sent to phonopy mailing list (https://sourceforge.net/p/phonopy/mailman/).
## Development
The development of phonopy is managed on the `develop` branch of github phonopy repository.
* Github issues is the place to discuss about phonopy issues.
* Github pull request is the place to request merging source code.
## Documentation
Phonopy user documetation is written using python sphinx. The source files are stored in `doc` directory. Please see how to write the documentation at `doc/README.md`.