[](https://anaconda.org/conda-forge/phonopy)
[](https://anaconda.org/conda-forge/phonopy)
[](https://pypi.python.org/pypi/phonopy)
[](https://codecov.io/gh/phonopy/phonopy)
# Phonopy
Phonon code mainly written in python. Phonopy user documentation is found at
http://phonopy.github.io/phonopy/
## Installation
See https://phonopy.github.io/phonopy/install.html.
## 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.
### Formatting
Formatting rules are found in `pyproject.toml`.
### pre-commit
Pre-commit (https://pre-commit.com/) is mainly used for applying the formatting
rules automatically. Therefore, it is strongly encouraged to use it at or before
git-commit. Pre-commit is set-up and used in the following way:
- Installed by `pip install pre-commit`, `conda install pre_commit` or see
https://pre-commit.com/#install.
- pre-commit hook is installed by `pre-commit install`.
- pre-commit hook is run by `pre-commit run --all-files`.
Unless running pre-commit, pre-commit.ci may push the fix at PR by github
action. In this case, the fix should be merged by the contributor's repository.
### VSCode setting
- Not strictly, but VSCode's `settings.json` may be written like below
```json
"ruff.lint.args": [
"--config=${workspaceFolder}/pyproject.toml",
],
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.codeActionsOnSave": {
"source.organizeImports": "explicit"
}
},
```
## Documentation
Phonopy user documentation is written using python sphinx. The source files are
stored in `doc` directory. Please see how to write the documentation at
`doc/README.md`.
## How to run tests
Tests are written using pytest. To run tests, pytest has to be installed. The
tests can be run by
```bash
% pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "phonopy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Atsushi Togo <atz.togo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6a/9e/59eefbda928f7350d20333a3eb2962fd78726eec746a81a70ad112a7366a/phonopy-2.43.5.tar.gz",
"platform": null,
"description": "[](https://anaconda.org/conda-forge/phonopy)\n[](https://anaconda.org/conda-forge/phonopy)\n[](https://pypi.python.org/pypi/phonopy)\n[](https://codecov.io/gh/phonopy/phonopy)\n\n# Phonopy\n\nPhonon code mainly written in python. Phonopy user documentation is found at\nhttp://phonopy.github.io/phonopy/\n\n## Installation\n\nSee https://phonopy.github.io/phonopy/install.html.\n\n## Mailing list for questions\n\nUsual phonopy questions should be sent to phonopy mailing list\n(https://sourceforge.net/p/phonopy/mailman/).\n\n## Development\n\nThe development of phonopy is managed on the `develop` branch of github phonopy\nrepository.\n\n- Github issues is the place to discuss about phonopy issues.\n- Github pull request is the place to request merging source code.\n\n### Formatting\n\nFormatting rules are found in `pyproject.toml`.\n\n### pre-commit\n\nPre-commit (https://pre-commit.com/) is mainly used for applying the formatting\nrules automatically. Therefore, it is strongly encouraged to use it at or before\ngit-commit. Pre-commit is set-up and used in the following way:\n\n- Installed by `pip install pre-commit`, `conda install pre_commit` or see\n https://pre-commit.com/#install.\n- pre-commit hook is installed by `pre-commit install`.\n- pre-commit hook is run by `pre-commit run --all-files`.\n\nUnless running pre-commit, pre-commit.ci may push the fix at PR by github\naction. In this case, the fix should be merged by the contributor's repository.\n\n### VSCode setting\n- Not strictly, but VSCode's `settings.json` may be written like below\n\n ```json\n \"ruff.lint.args\": [\n \"--config=${workspaceFolder}/pyproject.toml\",\n ],\n \"[python]\": {\n \"editor.defaultFormatter\": \"charliermarsh.ruff\",\n \"editor.codeActionsOnSave\": {\n \"source.organizeImports\": \"explicit\"\n }\n },\n ```\n\n## Documentation\n\nPhonopy user documentation is written using python sphinx. The source files are\nstored in `doc` directory. Please see how to write the documentation at\n`doc/README.md`.\n\n## How to run tests\n\nTests are written using pytest. To run tests, pytest has to be installed. The\ntests can be run by\n\n```bash\n% pytest\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "This is the phonopy module.",
"version": "2.43.5",
"project_urls": {
"Homepage": "https://phonopy.github.io/phonopy/",
"Repository": "https://github.com/phonopy/phonopy"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6a9e59eefbda928f7350d20333a3eb2962fd78726eec746a81a70ad112a7366a",
"md5": "2fad8a53ce05e710f41fbede1c628194",
"sha256": "10f51836925cfde4a7723fe34f4383c54873fcd7030891fca763ce8d6eb2bb5a"
},
"downloads": -1,
"filename": "phonopy-2.43.5.tar.gz",
"has_sig": false,
"md5_digest": "2fad8a53ce05e710f41fbede1c628194",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4757207,
"upload_time": "2025-10-18T04:24:00",
"upload_time_iso_8601": "2025-10-18T04:24:00.218152Z",
"url": "https://files.pythonhosted.org/packages/6a/9e/59eefbda928f7350d20333a3eb2962fd78726eec746a81a70ad112a7366a/phonopy-2.43.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-18 04:24:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phonopy",
"github_project": "phonopy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.17.0"
]
]
},
{
"name": "PyYAML",
"specs": [
[
">=",
"5.3"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"2.2.2"
]
]
},
{
"name": "h5py",
"specs": [
[
">=",
"3.0"
]
]
},
{
"name": "spglib",
"specs": [
[
">=",
"2.3"
]
]
}
],
"lcname": "phonopy"
}
JSON
